2 * Copyright (c) 2009, 2010, 2011, 2012 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 nx_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 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 */
138 static void ofservice_reconfigure(struct ofservice *,
139 const struct ofproto_controller *);
140 static int ofservice_create(struct connmgr *mgr, const char *target,
141 uint32_t allowed_versions, uint8_t dscp);
142 static void ofservice_destroy(struct connmgr *, struct ofservice *);
143 static struct ofservice *ofservice_lookup(struct connmgr *,
146 /* Connection manager for an OpenFlow switch. */
148 struct ofproto *ofproto;
150 char *local_port_name;
152 /* OpenFlow connections. */
153 struct hmap controllers; /* Controller "struct ofconn"s. */
154 struct list all_conns; /* Contains "struct ofconn"s. */
156 /* OpenFlow listeners. */
157 struct hmap services; /* Contains "struct ofservice"s. */
158 struct pvconn **snoops;
162 struct fail_open *fail_open;
163 enum ofproto_fail_mode fail_mode;
165 /* In-band control. */
166 struct in_band *in_band;
167 struct sockaddr_in *extra_in_band_remotes;
168 size_t n_extra_remotes;
172 static void update_in_band_remotes(struct connmgr *);
173 static void add_snooper(struct connmgr *, struct vconn *);
174 static void ofmonitor_run(struct connmgr *);
175 static void ofmonitor_wait(struct connmgr *);
177 /* Creates and returns a new connection manager owned by 'ofproto'. 'name' is
178 * a name for the ofproto suitable for using in log messages.
179 * 'local_port_name' is the name of the local port (OFPP_LOCAL) within
182 connmgr_create(struct ofproto *ofproto,
183 const char *name, const char *local_port_name)
187 mgr = xmalloc(sizeof *mgr);
188 mgr->ofproto = ofproto;
189 mgr->name = xstrdup(name);
190 mgr->local_port_name = xstrdup(local_port_name);
192 hmap_init(&mgr->controllers);
193 list_init(&mgr->all_conns);
195 hmap_init(&mgr->services);
199 mgr->fail_open = NULL;
200 mgr->fail_mode = OFPROTO_FAIL_SECURE;
203 mgr->extra_in_band_remotes = NULL;
204 mgr->n_extra_remotes = 0;
205 mgr->in_band_queue = -1;
210 /* Frees 'mgr' and all of its resources. */
212 connmgr_destroy(struct connmgr *mgr)
214 struct ofservice *ofservice, *next_ofservice;
215 struct ofconn *ofconn, *next_ofconn;
222 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
223 ofconn_destroy(ofconn);
225 hmap_destroy(&mgr->controllers);
227 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
228 ofservice_destroy(mgr, ofservice);
230 hmap_destroy(&mgr->services);
232 for (i = 0; i < mgr->n_snoops; i++) {
233 pvconn_close(mgr->snoops[i]);
237 fail_open_destroy(mgr->fail_open);
238 mgr->fail_open = NULL;
240 in_band_destroy(mgr->in_band);
242 free(mgr->extra_in_band_remotes);
244 free(mgr->local_port_name);
249 /* Does all of the periodic maintenance required by 'mgr'.
251 * If 'handle_openflow' is nonnull, calls 'handle_openflow' for each message
252 * received on an OpenFlow connection, passing along the OpenFlow connection
253 * itself and the message that was sent. If 'handle_openflow' returns true,
254 * the message is considered to be fully processed. If 'handle_openflow'
255 * returns false, the message is considered not to have been processed at all;
256 * it will be stored and re-presented to 'handle_openflow' following the next
257 * call to connmgr_retry(). 'handle_openflow' must not modify or free the
260 * If 'handle_openflow' is NULL, no OpenFlow messages will be processed and
261 * other activities that could affect the flow table (in-band processing,
262 * fail-open processing) are suppressed too. */
264 connmgr_run(struct connmgr *mgr,
265 bool (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
267 struct ofconn *ofconn, *next_ofconn;
268 struct ofservice *ofservice;
271 if (handle_openflow && mgr->in_band) {
272 if (!in_band_run(mgr->in_band)) {
273 in_band_destroy(mgr->in_band);
278 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
279 ofconn_run(ofconn, handle_openflow);
283 /* Fail-open maintenance. Do this after processing the ofconns since
284 * fail-open checks the status of the controller rconn. */
285 if (handle_openflow && mgr->fail_open) {
286 fail_open_run(mgr->fail_open);
289 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
293 retval = pvconn_accept(ofservice->pvconn, &vconn);
298 /* Passing default value for creation of the rconn */
299 rconn = rconn_create(ofservice->probe_interval, 0, ofservice->dscp,
300 vconn_get_allowed_versions(vconn));
301 name = ofconn_make_name(mgr, vconn_get_name(vconn));
302 rconn_connect_unreliably(rconn, vconn, name);
305 ofconn = ofconn_create(mgr, rconn, OFCONN_SERVICE,
306 ofservice->enable_async_msgs);
307 ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
308 ofservice->burst_limit);
309 } else if (retval != EAGAIN) {
310 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
314 for (i = 0; i < mgr->n_snoops; i++) {
318 retval = pvconn_accept(mgr->snoops[i], &vconn);
320 add_snooper(mgr, vconn);
321 } else if (retval != EAGAIN) {
322 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
327 /* Causes the poll loop to wake up when connmgr_run() needs to run.
329 * If 'handling_openflow' is true, arriving OpenFlow messages and other
330 * activities that affect the flow table will wake up the poll loop. If
331 * 'handling_openflow' is false, they will not. */
333 connmgr_wait(struct connmgr *mgr, bool handling_openflow)
335 struct ofservice *ofservice;
336 struct ofconn *ofconn;
339 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
340 ofconn_wait(ofconn, handling_openflow);
343 if (handling_openflow && mgr->in_band) {
344 in_band_wait(mgr->in_band);
346 if (handling_openflow && mgr->fail_open) {
347 fail_open_wait(mgr->fail_open);
349 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
350 pvconn_wait(ofservice->pvconn);
352 for (i = 0; i < mgr->n_snoops; i++) {
353 pvconn_wait(mgr->snoops[i]);
357 /* Adds some memory usage statistics for 'mgr' into 'usage', for use with
358 * memory_report(). */
360 connmgr_get_memory_usage(const struct connmgr *mgr, struct simap *usage)
362 const struct ofconn *ofconn;
363 unsigned int packets = 0;
364 unsigned int ofconns = 0;
366 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
371 packets += rconn_count_txqlen(ofconn->rconn);
372 for (i = 0; i < N_SCHEDULERS; i++) {
373 packets += pinsched_count_txqlen(ofconn->schedulers[i]);
375 packets += pktbuf_count_packets(ofconn->pktbuf);
377 simap_increase(usage, "ofconns", ofconns);
378 simap_increase(usage, "packets", packets);
381 /* Returns the ofproto that owns 'ofconn''s connmgr. */
383 ofconn_get_ofproto(const struct ofconn *ofconn)
385 return ofconn->connmgr->ofproto;
388 /* If processing of OpenFlow messages was blocked on any 'mgr' ofconns by
389 * returning false to the 'handle_openflow' callback to connmgr_run(), this
390 * re-enables them. */
392 connmgr_retry(struct connmgr *mgr)
394 struct ofconn *ofconn;
396 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
397 ofconn->retry = true;
401 /* OpenFlow configuration. */
403 static void add_controller(struct connmgr *, const char *target, uint8_t dscp,
404 uint32_t allowed_versions);
405 static struct ofconn *find_controller_by_target(struct connmgr *,
407 static void update_fail_open(struct connmgr *);
408 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
409 const struct sset *);
411 /* Returns true if 'mgr' has any configured primary controllers.
413 * Service controllers do not count, but configured primary controllers do
414 * count whether or not they are currently connected. */
416 connmgr_has_controllers(const struct connmgr *mgr)
418 return !hmap_is_empty(&mgr->controllers);
421 /* Initializes 'info' and populates it with information about each configured
422 * primary controller. The keys in 'info' are the controllers' targets; the
423 * data values are corresponding "struct ofproto_controller_info".
425 * The caller owns 'info' and everything in it and should free it when it is no
428 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
430 const struct ofconn *ofconn;
432 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
433 const struct rconn *rconn = ofconn->rconn;
434 const char *target = rconn_get_target(rconn);
436 if (!shash_find(info, target)) {
437 struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
438 time_t now = time_now();
439 time_t last_connection = rconn_get_last_connection(rconn);
440 time_t last_disconnect = rconn_get_last_disconnect(rconn);
441 int last_error = rconn_get_last_error(rconn);
443 shash_add(info, target, cinfo);
445 cinfo->is_connected = rconn_is_connected(rconn);
446 cinfo->role = ofconn->role;
451 cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
452 cinfo->pairs.values[cinfo->pairs.n++]
453 = xstrdup(ovs_retval_to_string(last_error));
456 cinfo->pairs.keys[cinfo->pairs.n] = "state";
457 cinfo->pairs.values[cinfo->pairs.n++]
458 = xstrdup(rconn_get_state(rconn));
460 if (last_connection != TIME_MIN) {
461 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_connect";
462 cinfo->pairs.values[cinfo->pairs.n++]
463 = xasprintf("%ld", (long int) (now - last_connection));
466 if (last_disconnect != TIME_MIN) {
467 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_disconnect";
468 cinfo->pairs.values[cinfo->pairs.n++]
469 = xasprintf("%ld", (long int) (now - last_disconnect));
476 connmgr_free_controller_info(struct shash *info)
478 struct shash_node *node;
480 SHASH_FOR_EACH (node, info) {
481 struct ofproto_controller_info *cinfo = node->data;
482 while (cinfo->pairs.n) {
483 free(CONST_CAST(char *, cinfo->pairs.values[--cinfo->pairs.n]));
490 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
493 connmgr_set_controllers(struct connmgr *mgr,
494 const struct ofproto_controller *controllers,
495 size_t n_controllers, uint32_t allowed_versions)
497 bool had_controllers = connmgr_has_controllers(mgr);
498 struct shash new_controllers;
499 struct ofconn *ofconn, *next_ofconn;
500 struct ofservice *ofservice, *next_ofservice;
503 /* Create newly configured controllers and services.
504 * Create a name to ofproto_controller mapping in 'new_controllers'. */
505 shash_init(&new_controllers);
506 for (i = 0; i < n_controllers; i++) {
507 const struct ofproto_controller *c = &controllers[i];
509 if (!vconn_verify_name(c->target)) {
510 if (!find_controller_by_target(mgr, c->target)) {
511 VLOG_INFO("%s: added primary controller \"%s\"",
512 mgr->name, c->target);
513 add_controller(mgr, c->target, c->dscp, allowed_versions);
515 } else if (!pvconn_verify_name(c->target)) {
516 if (!ofservice_lookup(mgr, c->target)) {
517 VLOG_INFO("%s: added service controller \"%s\"",
518 mgr->name, c->target);
519 ofservice_create(mgr, c->target, allowed_versions, c->dscp);
522 VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
523 mgr->name, c->target);
527 shash_add_once(&new_controllers, c->target, &controllers[i]);
530 /* Delete controllers that are no longer configured.
531 * Update configuration of all now-existing controllers. */
532 HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
533 const char *target = ofconn_get_target(ofconn);
534 struct ofproto_controller *c;
536 c = shash_find_data(&new_controllers, target);
538 VLOG_INFO("%s: removed primary controller \"%s\"",
540 ofconn_destroy(ofconn);
542 ofconn_reconfigure(ofconn, c);
546 /* Delete services that are no longer configured.
547 * Update configuration of all now-existing services. */
548 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
549 const char *target = pvconn_get_name(ofservice->pvconn);
550 struct ofproto_controller *c;
552 c = shash_find_data(&new_controllers, target);
554 VLOG_INFO("%s: removed service controller \"%s\"",
556 ofservice_destroy(mgr, ofservice);
558 ofservice_reconfigure(ofservice, c);
562 shash_destroy(&new_controllers);
564 update_in_band_remotes(mgr);
565 update_fail_open(mgr);
566 if (had_controllers != connmgr_has_controllers(mgr)) {
567 ofproto_flush_flows(mgr->ofproto);
571 /* Drops the connections between 'mgr' and all of its primary and secondary
572 * controllers, forcing them to reconnect. */
574 connmgr_reconnect(const struct connmgr *mgr)
576 struct ofconn *ofconn;
578 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
579 rconn_reconnect(ofconn->rconn);
583 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
585 * A "snoop" is a pvconn to which every OpenFlow message to or from the most
586 * important controller on 'mgr' is mirrored. */
588 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
590 return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
593 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
595 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
599 for (i = 0; i < mgr->n_snoops; i++) {
600 sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
604 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
606 connmgr_has_snoops(const struct connmgr *mgr)
608 return mgr->n_snoops > 0;
611 /* Creates a new controller for 'target' in 'mgr'. update_controller() needs
612 * to be called later to finish the new ofconn's configuration. */
614 add_controller(struct connmgr *mgr, const char *target, uint8_t dscp,
615 uint32_t allowed_versions)
617 char *name = ofconn_make_name(mgr, target);
618 struct ofconn *ofconn;
620 ofconn = ofconn_create(mgr, rconn_create(5, 8, dscp, allowed_versions),
621 OFCONN_PRIMARY, true);
622 ofconn->pktbuf = pktbuf_create();
623 rconn_connect(ofconn->rconn, target, name);
624 hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
629 static struct ofconn *
630 find_controller_by_target(struct connmgr *mgr, const char *target)
632 struct ofconn *ofconn;
634 HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
635 hash_string(target, 0), &mgr->controllers) {
636 if (!strcmp(ofconn_get_target(ofconn), target)) {
644 update_in_band_remotes(struct connmgr *mgr)
646 struct sockaddr_in *addrs;
647 size_t max_addrs, n_addrs;
648 struct ofconn *ofconn;
651 /* Allocate enough memory for as many remotes as we could possibly have. */
652 max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
653 addrs = xmalloc(max_addrs * sizeof *addrs);
656 /* Add all the remotes. */
657 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
658 struct sockaddr_in *sin = &addrs[n_addrs];
659 const char *target = rconn_get_target(ofconn->rconn);
661 if (ofconn->band == OFPROTO_OUT_OF_BAND) {
665 if (stream_parse_target_with_default_ports(target,
672 for (i = 0; i < mgr->n_extra_remotes; i++) {
673 addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
676 /* Create or update or destroy in-band. */
679 in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
681 in_band_set_queue(mgr->in_band, mgr->in_band_queue);
683 /* in_band_run() needs a chance to delete any existing in-band flows.
684 * We will destroy mgr->in_band after it's done with that. */
687 in_band_set_remotes(mgr->in_band, addrs, n_addrs);
695 update_fail_open(struct connmgr *mgr)
697 if (connmgr_has_controllers(mgr)
698 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
699 if (!mgr->fail_open) {
700 mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
703 fail_open_destroy(mgr->fail_open);
704 mgr->fail_open = NULL;
709 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
710 const struct sset *sset)
712 struct pvconn **pvconns = *pvconnsp;
713 size_t n_pvconns = *n_pvconnsp;
718 for (i = 0; i < n_pvconns; i++) {
719 pvconn_close(pvconns[i]);
723 pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
725 SSET_FOR_EACH (name, sset) {
726 struct pvconn *pvconn;
728 error = pvconn_open(name, 0, &pvconn, 0);
730 pvconns[n_pvconns++] = pvconn;
732 VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
740 *n_pvconnsp = n_pvconns;
745 /* Returns a "preference level" for snooping 'ofconn'. A higher return value
746 * means that 'ofconn' is more interesting for monitoring than a lower return
749 snoop_preference(const struct ofconn *ofconn)
751 switch (ofconn->role) {
759 /* Shouldn't happen. */
764 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
765 * Connects this vconn to a controller. */
767 add_snooper(struct connmgr *mgr, struct vconn *vconn)
769 struct ofconn *ofconn, *best;
771 /* Pick a controller for monitoring. */
773 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
774 if (ofconn->type == OFCONN_PRIMARY
775 && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
781 rconn_add_monitor(best->rconn, vconn);
783 VLOG_INFO_RL(&rl, "no controller connection to snoop");
788 /* Public ofconn functions. */
790 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
792 ofconn_get_type(const struct ofconn *ofconn)
797 /* Returns the role configured for 'ofconn'.
799 * The default role, if no other role has been set, is NX_ROLE_OTHER. */
801 ofconn_get_role(const struct ofconn *ofconn)
806 /* Changes 'ofconn''s role to 'role'. If 'role' is NX_ROLE_MASTER then any
807 * existing master is demoted to a slave. */
809 ofconn_set_role(struct ofconn *ofconn, enum nx_role role)
811 if (role == NX_ROLE_MASTER) {
812 struct ofconn *other;
814 HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
815 if (other->role == NX_ROLE_MASTER) {
816 other->role = NX_ROLE_SLAVE;
824 ofconn_set_invalid_ttl_to_controller(struct ofconn *ofconn, bool enable)
826 uint32_t bit = 1u << OFPR_INVALID_TTL;
828 ofconn->master_async_config[OAM_PACKET_IN] |= bit;
830 ofconn->master_async_config[OAM_PACKET_IN] &= ~bit;
835 ofconn_get_invalid_ttl_to_controller(struct ofconn *ofconn)
837 uint32_t bit = 1u << OFPR_INVALID_TTL;
838 return (ofconn->master_async_config[OAM_PACKET_IN] & bit) != 0;
841 /* Returns the currently configured protocol for 'ofconn', one of OFPUTIL_P_*.
843 * Returns OFPUTIL_P_NONE, which is not a valid protocol, if 'ofconn' hasn't
844 * completed version negotiation. This can't happen if at least one OpenFlow
845 * message, other than OFPT_HELLO, has been received on the connection (such as
846 * in ofproto.c's message handling code), since version negotiation is a
847 * prerequisite for starting to receive messages. This means that
848 * OFPUTIL_P_NONE is a special case that most callers need not worry about. */
849 enum ofputil_protocol
850 ofconn_get_protocol(const struct ofconn *ofconn)
852 if (ofconn->protocol == OFPUTIL_P_NONE &&
853 rconn_is_connected(ofconn->rconn)) {
854 int version = rconn_get_version(ofconn->rconn);
856 ofconn_set_protocol(CONST_CAST(struct ofconn *, ofconn),
857 ofputil_protocol_from_ofp_version(version));
861 return ofconn->protocol;
864 /* Sets the protocol for 'ofconn' to 'protocol' (one of OFPUTIL_P_*).
866 * (This doesn't actually send anything to accomplish this. Presumably the
867 * caller already did that.) */
869 ofconn_set_protocol(struct ofconn *ofconn, enum ofputil_protocol protocol)
871 ofconn->protocol = protocol;
874 /* Returns the currently configured packet in format for 'ofconn', one of
877 * The default, if no other format has been set, is NXPIF_OPENFLOW10. */
878 enum nx_packet_in_format
879 ofconn_get_packet_in_format(struct ofconn *ofconn)
881 return ofconn->packet_in_format;
884 /* Sets the packet in format for 'ofconn' to 'packet_in_format' (one of
887 ofconn_set_packet_in_format(struct ofconn *ofconn,
888 enum nx_packet_in_format packet_in_format)
890 ofconn->packet_in_format = packet_in_format;
893 /* Sets the controller connection ID for 'ofconn' to 'controller_id'.
895 * The connection controller ID is used for OFPP_CONTROLLER and
896 * NXAST_CONTROLLER actions. See "struct nx_action_controller" for details. */
898 ofconn_set_controller_id(struct ofconn *ofconn, uint16_t controller_id)
900 ofconn->controller_id = controller_id;
903 /* Returns the default miss send length for 'ofconn'. */
905 ofconn_get_miss_send_len(const struct ofconn *ofconn)
907 return ofconn->miss_send_len;
910 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
912 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
914 ofconn->miss_send_len = miss_send_len;
918 ofconn_set_async_config(struct ofconn *ofconn,
919 const uint32_t master_masks[OAM_N_TYPES],
920 const uint32_t slave_masks[OAM_N_TYPES])
922 size_t size = sizeof ofconn->master_async_config;
923 memcpy(ofconn->master_async_config, master_masks, size);
924 memcpy(ofconn->slave_async_config, slave_masks, size);
927 /* Sends 'msg' on 'ofconn', accounting it as a reply. (If there is a
928 * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
929 * connmgr will stop accepting new OpenFlow requests on that ofconn until the
930 * controller has accepted some of the replies.) */
932 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
934 ofconn_send(ofconn, msg, ofconn->reply_counter);
937 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
938 * accounting them as replies. */
940 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
942 struct ofpbuf *reply, *next;
944 LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
945 list_remove(&reply->list_node);
946 ofconn_send_reply(ofconn, reply);
950 /* Sends 'error' on 'ofconn', as a reply to 'request'. Only at most the
951 * first 64 bytes of 'request' are used. */
953 ofconn_send_error(const struct ofconn *ofconn,
954 const struct ofp_header *request, enum ofperr error)
956 struct ofpbuf *reply;
958 reply = ofperr_encode_reply(error, request);
960 static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(10, 10);
962 if (!VLOG_DROP_INFO(&err_rl)) {
963 const char *type_name;
967 request_len = ntohs(request->length);
968 type_name = (!ofpraw_decode_partial(&raw, request,
969 MIN(64, request_len))
970 ? ofpraw_get_name(raw)
973 VLOG_INFO("%s: sending %s error reply to %s message",
974 rconn_get_name(ofconn->rconn), ofperr_to_string(error),
977 ofconn_send_reply(ofconn, reply);
981 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
983 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
984 struct ofpbuf **bufferp, uint16_t *in_port)
986 return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
989 /* Returns true if 'ofconn' has any pending opgroups. */
991 ofconn_has_pending_opgroups(const struct ofconn *ofconn)
993 return !list_is_empty(&ofconn->opgroups);
996 /* Adds 'ofconn_node' to 'ofconn''s list of pending opgroups.
998 * If 'ofconn' is destroyed or its connection drops, then 'ofconn' will remove
999 * 'ofconn_node' from the list and re-initialize it with list_init(). The
1000 * client may, therefore, use list_is_empty(ofconn_node) to determine whether
1001 * 'ofconn_node' is still associated with an active ofconn.
1003 * The client may also remove ofconn_node from the list itself, with
1006 ofconn_add_opgroup(struct ofconn *ofconn, struct list *ofconn_node)
1008 list_push_back(&ofconn->opgroups, ofconn_node);
1011 /* Private ofconn functions. */
1014 ofconn_get_target(const struct ofconn *ofconn)
1016 return rconn_get_target(ofconn->rconn);
1019 static struct ofconn *
1020 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type,
1021 bool enable_async_msgs)
1023 struct ofconn *ofconn;
1025 ofconn = xzalloc(sizeof *ofconn);
1026 ofconn->connmgr = mgr;
1027 list_push_back(&mgr->all_conns, &ofconn->node);
1028 ofconn->rconn = rconn;
1029 ofconn->type = type;
1030 ofconn->enable_async_msgs = enable_async_msgs;
1032 list_init(&ofconn->opgroups);
1034 hmap_init(&ofconn->monitors);
1035 list_init(&ofconn->updates);
1037 ofconn_flush(ofconn);
1042 /* Clears all of the state in 'ofconn' that should not persist from one
1043 * connection to the next. */
1045 ofconn_flush(struct ofconn *ofconn)
1047 struct ofmonitor *monitor, *next_monitor;
1050 ofconn->role = NX_ROLE_OTHER;
1051 ofconn_set_protocol(ofconn, OFPUTIL_P_NONE);
1052 ofconn->packet_in_format = NXPIF_OPENFLOW10;
1054 /* Disassociate 'ofconn' from all of the ofopgroups that it initiated that
1055 * have not yet completed. (Those ofopgroups will still run to completion
1056 * in the usual way, but any errors that they run into will not be reported
1057 * on any OpenFlow channel.)
1059 * Also discard any blocked operation on 'ofconn'. */
1060 while (!list_is_empty(&ofconn->opgroups)) {
1061 list_init(list_pop_front(&ofconn->opgroups));
1063 ofpbuf_delete(ofconn->blocked);
1064 ofconn->blocked = NULL;
1066 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1067 ofconn->packet_in_counter = rconn_packet_counter_create();
1068 for (i = 0; i < N_SCHEDULERS; i++) {
1069 if (ofconn->schedulers[i]) {
1072 pinsched_get_limits(ofconn->schedulers[i], &rate, &burst);
1073 pinsched_destroy(ofconn->schedulers[i]);
1074 ofconn->schedulers[i] = pinsched_create(rate, burst);
1077 if (ofconn->pktbuf) {
1078 pktbuf_destroy(ofconn->pktbuf);
1079 ofconn->pktbuf = pktbuf_create();
1081 ofconn->miss_send_len = (ofconn->type == OFCONN_PRIMARY
1082 ? OFP_DEFAULT_MISS_SEND_LEN
1084 ofconn->controller_id = 0;
1086 rconn_packet_counter_destroy(ofconn->reply_counter);
1087 ofconn->reply_counter = rconn_packet_counter_create();
1089 if (ofconn->enable_async_msgs) {
1090 uint32_t *master = ofconn->master_async_config;
1091 uint32_t *slave = ofconn->slave_async_config;
1093 /* "master" and "other" roles get all asynchronous messages by default,
1094 * except that the controller needs to enable nonstandard "packet-in"
1095 * reasons itself. */
1096 master[OAM_PACKET_IN] = (1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION);
1097 master[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1098 | (1u << OFPPR_DELETE)
1099 | (1u << OFPPR_MODIFY));
1100 master[OAM_FLOW_REMOVED] = ((1u << OFPRR_IDLE_TIMEOUT)
1101 | (1u << OFPRR_HARD_TIMEOUT)
1102 | (1u << OFPRR_DELETE));
1104 /* "slave" role gets port status updates by default. */
1105 slave[OAM_PACKET_IN] = 0;
1106 slave[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1107 | (1u << OFPPR_DELETE)
1108 | (1u << OFPPR_MODIFY));
1109 slave[OAM_FLOW_REMOVED] = 0;
1111 memset(ofconn->master_async_config, 0,
1112 sizeof ofconn->master_async_config);
1113 memset(ofconn->slave_async_config, 0,
1114 sizeof ofconn->slave_async_config);
1117 HMAP_FOR_EACH_SAFE (monitor, next_monitor, ofconn_node,
1118 &ofconn->monitors) {
1119 ofmonitor_destroy(monitor);
1121 rconn_packet_counter_destroy(ofconn->monitor_counter);
1122 ofconn->monitor_counter = rconn_packet_counter_create();
1123 ofpbuf_list_delete(&ofconn->updates); /* ...but it should be empty. */
1127 ofconn_destroy(struct ofconn *ofconn)
1129 ofconn_flush(ofconn);
1131 if (ofconn->type == OFCONN_PRIMARY) {
1132 hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
1135 list_remove(&ofconn->node);
1136 rconn_destroy(ofconn->rconn);
1137 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1138 rconn_packet_counter_destroy(ofconn->reply_counter);
1139 pktbuf_destroy(ofconn->pktbuf);
1140 rconn_packet_counter_destroy(ofconn->monitor_counter);
1144 /* Reconfigures 'ofconn' to match 'c'. 'ofconn' and 'c' must have the same
1147 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
1151 ofconn->band = c->band;
1152 ofconn->enable_async_msgs = c->enable_async_msgs;
1154 rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
1156 probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
1157 rconn_set_probe_interval(ofconn->rconn, probe_interval);
1159 ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
1161 /* If dscp value changed reconnect. */
1162 if (c->dscp != rconn_get_dscp(ofconn->rconn)) {
1163 rconn_set_dscp(ofconn->rconn, c->dscp);
1164 rconn_reconnect(ofconn->rconn);
1168 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
1171 ofconn_may_recv(const struct ofconn *ofconn)
1173 int count = ofconn->reply_counter->n_packets;
1174 return (!ofconn->blocked || ofconn->retry) && count < OFCONN_REPLY_MAX;
1178 ofconn_run(struct ofconn *ofconn,
1179 bool (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
1181 struct connmgr *mgr = ofconn->connmgr;
1184 for (i = 0; i < N_SCHEDULERS; i++) {
1185 pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1188 rconn_run(ofconn->rconn);
1190 if (handle_openflow) {
1191 /* Limit the number of iterations to avoid starving other tasks. */
1192 for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
1193 struct ofpbuf *of_msg;
1195 of_msg = (ofconn->blocked
1197 : rconn_recv(ofconn->rconn));
1201 if (mgr->fail_open) {
1202 fail_open_maybe_recover(mgr->fail_open);
1205 if (handle_openflow(ofconn, of_msg)) {
1206 ofpbuf_delete(of_msg);
1207 ofconn->blocked = NULL;
1209 ofconn->blocked = of_msg;
1210 ofconn->retry = false;
1215 if (!rconn_is_alive(ofconn->rconn)) {
1216 ofconn_destroy(ofconn);
1217 } else if (!rconn_is_connected(ofconn->rconn)) {
1218 ofconn_flush(ofconn);
1223 ofconn_wait(struct ofconn *ofconn, bool handling_openflow)
1227 for (i = 0; i < N_SCHEDULERS; i++) {
1228 pinsched_wait(ofconn->schedulers[i]);
1230 rconn_run_wait(ofconn->rconn);
1231 if (handling_openflow && ofconn_may_recv(ofconn)) {
1232 rconn_recv_wait(ofconn->rconn);
1236 /* Returns true if 'ofconn' should receive asynchronous messages of the given
1237 * OAM_* 'type' and 'reason', which should be a OFPR_* value for OAM_PACKET_IN,
1238 * a OFPPR_* value for OAM_PORT_STATUS, or an OFPRR_* value for
1239 * OAM_FLOW_REMOVED. Returns false if the message should not be sent on
1242 ofconn_receives_async_msg(const struct ofconn *ofconn,
1243 enum ofconn_async_msg_type type,
1244 unsigned int reason)
1246 const uint32_t *async_config;
1248 assert(reason < 32);
1249 assert((unsigned int) type < OAM_N_TYPES);
1251 if (ofconn_get_protocol(ofconn) == OFPUTIL_P_NONE
1252 || !rconn_is_connected(ofconn->rconn)) {
1256 /* Keep the following code in sync with the documentation in the
1257 * "Asynchronous Messages" section in DESIGN. */
1259 if (ofconn->type == OFCONN_SERVICE && !ofconn->miss_send_len) {
1260 /* Service connections don't get asynchronous messages unless they have
1261 * explicitly asked for them by setting a nonzero miss send length. */
1265 async_config = (ofconn->role == NX_ROLE_SLAVE
1266 ? ofconn->slave_async_config
1267 : ofconn->master_async_config);
1268 if (!(async_config[type] & (1u << reason))) {
1275 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1276 * 'target', suitable for use in log messages for identifying the connection.
1278 * The name is dynamically allocated. The caller should free it (with free())
1279 * when it is no longer needed. */
1281 ofconn_make_name(const struct connmgr *mgr, const char *target)
1283 return xasprintf("%s<->%s", mgr->name, target);
1287 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1291 for (i = 0; i < N_SCHEDULERS; i++) {
1292 struct pinsched **s = &ofconn->schedulers[i];
1296 *s = pinsched_create(rate, burst);
1298 pinsched_set_limits(*s, rate, burst);
1301 pinsched_destroy(*s);
1308 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1309 struct rconn_packet_counter *counter)
1311 ofpmsg_update_length(msg);
1312 rconn_send(ofconn->rconn, msg, counter);
1315 /* Sending asynchronous messages. */
1317 static void schedule_packet_in(struct ofconn *, struct ofputil_packet_in);
1319 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1320 * controllers managed by 'mgr'. */
1322 connmgr_send_port_status(struct connmgr *mgr,
1323 const struct ofputil_phy_port *pp, uint8_t reason)
1325 /* XXX Should limit the number of queued port status change messages. */
1326 struct ofputil_port_status ps;
1327 struct ofconn *ofconn;
1331 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1332 if (ofconn_receives_async_msg(ofconn, OAM_PORT_STATUS, reason)) {
1335 msg = ofputil_encode_port_status(&ps, ofconn_get_protocol(ofconn));
1336 ofconn_send(ofconn, msg, NULL);
1341 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1342 * appropriate controllers managed by 'mgr'. */
1344 connmgr_send_flow_removed(struct connmgr *mgr,
1345 const struct ofputil_flow_removed *fr)
1347 struct ofconn *ofconn;
1349 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1350 if (ofconn_receives_async_msg(ofconn, OAM_FLOW_REMOVED, fr->reason)) {
1353 /* Account flow expirations as replies to OpenFlow requests. That
1354 * works because preventing OpenFlow requests from being processed
1355 * also prevents new flows from being added (and expiring). (It
1356 * also prevents processing OpenFlow requests that would not add
1357 * new flows, so it is imperfect.) */
1358 msg = ofputil_encode_flow_removed(fr, ofconn_get_protocol(ofconn));
1359 ofconn_send_reply(ofconn, msg);
1364 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1365 * necessary according to their individual configurations.
1367 * The caller doesn't need to fill in pin->buffer_id or pin->total_len. */
1369 connmgr_send_packet_in(struct connmgr *mgr,
1370 const struct ofputil_packet_in *pin)
1372 struct ofconn *ofconn;
1374 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1375 if (ofconn_receives_async_msg(ofconn, OAM_PACKET_IN, pin->reason)
1376 && ofconn->controller_id == pin->controller_id) {
1377 schedule_packet_in(ofconn, *pin);
1382 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1384 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1386 struct ofconn *ofconn = ofconn_;
1388 rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1389 ofconn->packet_in_counter, 100);
1392 /* Takes 'pin', composes an OpenFlow packet-in message from it, and passes it
1393 * to 'ofconn''s packet scheduler for sending. */
1395 schedule_packet_in(struct ofconn *ofconn, struct ofputil_packet_in pin)
1397 struct connmgr *mgr = ofconn->connmgr;
1399 pin.total_len = pin.packet_len;
1401 /* Get OpenFlow buffer_id. */
1402 if (pin.reason == OFPR_ACTION) {
1403 pin.buffer_id = UINT32_MAX;
1404 } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1405 pin.buffer_id = pktbuf_get_null();
1406 } else if (!ofconn->pktbuf) {
1407 pin.buffer_id = UINT32_MAX;
1409 pin.buffer_id = pktbuf_save(ofconn->pktbuf, pin.packet, pin.packet_len,
1413 /* Figure out how much of the packet to send. */
1414 if (pin.reason == OFPR_NO_MATCH) {
1415 pin.send_len = pin.packet_len;
1417 /* Caller should have initialized 'send_len' to 'max_len' specified in
1420 if (pin.buffer_id != UINT32_MAX) {
1421 pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1424 /* Make OFPT_PACKET_IN and hand over to packet scheduler. It might
1425 * immediately call into do_send_packet_in() or it might buffer it for a
1426 * while (until a later call to pinsched_run()). */
1427 pinsched_send(ofconn->schedulers[pin.reason == OFPR_NO_MATCH ? 0 : 1],
1429 ofputil_encode_packet_in(&pin, ofconn_get_protocol(ofconn),
1430 ofconn->packet_in_format),
1431 do_send_packet_in, ofconn);
1434 /* Fail-open settings. */
1436 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1437 * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1438 enum ofproto_fail_mode
1439 connmgr_get_fail_mode(const struct connmgr *mgr)
1441 return mgr->fail_mode;
1444 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1445 * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1447 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1449 if (mgr->fail_mode != fail_mode) {
1450 mgr->fail_mode = fail_mode;
1451 update_fail_open(mgr);
1452 if (!connmgr_has_controllers(mgr)) {
1453 ofproto_flush_flows(mgr->ofproto);
1458 /* Fail-open implementation. */
1460 /* Returns the longest probe interval among the primary controllers configured
1461 * on 'mgr'. Returns 0 if there are no primary controllers. */
1463 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1465 const struct ofconn *ofconn;
1466 int max_probe_interval;
1468 max_probe_interval = 0;
1469 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1470 int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1471 max_probe_interval = MAX(max_probe_interval, probe_interval);
1473 return max_probe_interval;
1476 /* Returns the number of seconds for which all of 'mgr's primary controllers
1477 * have been disconnected. Returns 0 if 'mgr' has no primary controllers. */
1479 connmgr_failure_duration(const struct connmgr *mgr)
1481 const struct ofconn *ofconn;
1482 int min_failure_duration;
1484 if (!connmgr_has_controllers(mgr)) {
1488 min_failure_duration = INT_MAX;
1489 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1490 int failure_duration = rconn_failure_duration(ofconn->rconn);
1491 min_failure_duration = MIN(min_failure_duration, failure_duration);
1493 return min_failure_duration;
1496 /* Returns true if at least one primary controller is connected (regardless of
1497 * whether those controllers are believed to have authenticated and accepted
1498 * this switch), false if none of them are connected. */
1500 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1502 const struct ofconn *ofconn;
1504 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1505 if (rconn_is_connected(ofconn->rconn)) {
1512 /* Returns true if at least one primary controller is believed to have
1513 * authenticated and accepted this switch, false otherwise. */
1515 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1517 const struct ofconn *ofconn;
1519 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1520 if (rconn_is_admitted(ofconn->rconn)) {
1527 /* In-band configuration. */
1529 static bool any_extras_changed(const struct connmgr *,
1530 const struct sockaddr_in *extras, size_t n);
1532 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1533 * in-band control should guarantee access, in the same way that in-band
1534 * control guarantees access to OpenFlow controllers. */
1536 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1537 const struct sockaddr_in *extras, size_t n)
1539 if (!any_extras_changed(mgr, extras, n)) {
1543 free(mgr->extra_in_band_remotes);
1544 mgr->n_extra_remotes = n;
1545 mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1547 update_in_band_remotes(mgr);
1550 /* Sets the OpenFlow queue used by flows set up by in-band control on
1551 * 'mgr' to 'queue_id'. If 'queue_id' is negative, then in-band control
1552 * flows will use the default queue. */
1554 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1556 if (queue_id != mgr->in_band_queue) {
1557 mgr->in_band_queue = queue_id;
1558 update_in_band_remotes(mgr);
1563 any_extras_changed(const struct connmgr *mgr,
1564 const struct sockaddr_in *extras, size_t n)
1568 if (n != mgr->n_extra_remotes) {
1572 for (i = 0; i < n; i++) {
1573 const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1574 const struct sockaddr_in *new = &extras[i];
1576 if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1577 old->sin_port != new->sin_port) {
1585 /* In-band implementation. */
1588 connmgr_msg_in_hook(struct connmgr *mgr, const struct flow *flow,
1589 const struct ofpbuf *packet)
1591 return mgr->in_band && in_band_msg_in_hook(mgr->in_band, flow, packet);
1595 connmgr_may_set_up_flow(struct connmgr *mgr, const struct flow *flow,
1596 const struct nlattr *odp_actions,
1599 return !mgr->in_band || in_band_rule_check(flow, odp_actions, actions_len);
1602 /* Fail-open and in-band implementation. */
1604 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1605 * and standalone mode to re-create their flows.
1607 * In-band control has more sophisticated code that manages flows itself. */
1609 connmgr_flushed(struct connmgr *mgr)
1611 if (mgr->fail_open) {
1612 fail_open_flushed(mgr->fail_open);
1615 /* If there are no controllers and we're in standalone mode, set up a flow
1616 * that matches every packet and directs them to OFPP_NORMAL (which goes to
1617 * us). Otherwise, the switch is in secure mode and we won't pass any
1618 * traffic until a controller has been defined and it tells us to do so. */
1619 if (!connmgr_has_controllers(mgr)
1620 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1621 struct ofpbuf ofpacts;
1624 ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
1625 ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
1626 ofpact_pad(&ofpacts);
1628 match_init_catchall(&match);
1629 ofproto_add_flow(mgr->ofproto, &match, 0, ofpacts.data, ofpacts.size);
1631 ofpbuf_uninit(&ofpacts);
1635 /* Creates a new ofservice for 'target' in 'mgr'. Returns 0 if successful,
1636 * otherwise a positive errno value.
1638 * ofservice_reconfigure() must be called to fully configure the new
1641 ofservice_create(struct connmgr *mgr, const char *target,
1642 uint32_t allowed_versions, uint8_t dscp)
1644 struct ofservice *ofservice;
1645 struct pvconn *pvconn;
1648 error = pvconn_open(target, allowed_versions, &pvconn, dscp);
1653 ofservice = xzalloc(sizeof *ofservice);
1654 hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1655 ofservice->pvconn = pvconn;
1661 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1663 hmap_remove(&mgr->services, &ofservice->node);
1664 pvconn_close(ofservice->pvconn);
1669 ofservice_reconfigure(struct ofservice *ofservice,
1670 const struct ofproto_controller *c)
1672 ofservice->probe_interval = c->probe_interval;
1673 ofservice->rate_limit = c->rate_limit;
1674 ofservice->burst_limit = c->burst_limit;
1675 ofservice->enable_async_msgs = c->enable_async_msgs;
1676 ofservice->dscp = c->dscp;
1679 /* Finds and returns the ofservice within 'mgr' that has the given
1680 * 'target', or a null pointer if none exists. */
1681 static struct ofservice *
1682 ofservice_lookup(struct connmgr *mgr, const char *target)
1684 struct ofservice *ofservice;
1686 HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1688 if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1695 /* Flow monitors (NXST_FLOW_MONITOR). */
1697 /* A counter incremented when something significant happens to an OpenFlow
1700 * - When a rule is added, its 'add_seqno' and 'modify_seqno' are set to
1701 * the current value (which is then incremented).
1703 * - When a rule is modified, its 'modify_seqno' is set to the current
1704 * value (which is then incremented).
1706 * Thus, by comparing an old value of monitor_seqno against a rule's
1707 * 'add_seqno', one can tell whether the rule was added before or after the old
1708 * value was read, and similarly for 'modify_seqno'.
1710 * 32 bits should normally be sufficient (and would be nice, to save space in
1711 * each rule) but then we'd have to have some special cases for wraparound.
1713 * We initialize monitor_seqno to 1 to allow 0 to be used as an invalid
1715 static uint64_t monitor_seqno = 1;
1717 COVERAGE_DEFINE(ofmonitor_pause);
1718 COVERAGE_DEFINE(ofmonitor_resume);
1721 ofmonitor_create(const struct ofputil_flow_monitor_request *request,
1722 struct ofconn *ofconn, struct ofmonitor **monitorp)
1724 struct ofmonitor *m;
1728 m = ofmonitor_lookup(ofconn, request->id);
1730 return OFPERR_NXBRC_FM_DUPLICATE_ID;
1733 m = xmalloc(sizeof *m);
1735 hmap_insert(&ofconn->monitors, &m->ofconn_node, hash_int(request->id, 0));
1736 m->id = request->id;
1737 m->flags = request->flags;
1738 m->out_port = request->out_port;
1739 m->table_id = request->table_id;
1740 minimatch_init(&m->match, &request->match);
1747 ofmonitor_lookup(struct ofconn *ofconn, uint32_t id)
1749 struct ofmonitor *m;
1751 HMAP_FOR_EACH_IN_BUCKET (m, ofconn_node, hash_int(id, 0),
1752 &ofconn->monitors) {
1761 ofmonitor_destroy(struct ofmonitor *m)
1764 hmap_remove(&m->ofconn->monitors, &m->ofconn_node);
1770 ofmonitor_report(struct connmgr *mgr, struct rule *rule,
1771 enum nx_flow_update_event event,
1772 enum ofp_flow_removed_reason reason,
1773 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
1775 enum nx_flow_monitor_flags update;
1776 struct ofconn *ofconn;
1781 rule->add_seqno = rule->modify_seqno = monitor_seqno++;
1785 update = NXFMF_DELETE;
1788 case NXFME_MODIFIED:
1789 update = NXFMF_MODIFY;
1790 rule->modify_seqno = monitor_seqno++;
1798 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1799 enum nx_flow_monitor_flags flags = 0;
1800 struct ofmonitor *m;
1802 if (ofconn->monitor_paused) {
1803 /* Only send NXFME_DELETED notifications for flows that were added
1804 * before we paused. */
1805 if (event != NXFME_DELETED
1806 || rule->add_seqno > ofconn->monitor_paused) {
1811 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1812 if (m->flags & update
1813 && (m->table_id == 0xff || m->table_id == rule->table_id)
1814 && ofoperation_has_out_port(rule->pending, m->out_port)
1815 && cls_rule_is_loose_match(&rule->cr, &m->match)) {
1821 if (list_is_empty(&ofconn->updates)) {
1822 ofputil_start_flow_update(&ofconn->updates);
1823 ofconn->sent_abbrev_update = false;
1826 if (ofconn != abbrev_ofconn || ofconn->monitor_paused) {
1827 struct ofputil_flow_update fu;
1831 fu.reason = event == NXFME_DELETED ? reason : 0;
1832 fu.idle_timeout = rule->idle_timeout;
1833 fu.hard_timeout = rule->hard_timeout;
1834 fu.table_id = rule->table_id;
1835 fu.cookie = rule->flow_cookie;
1836 minimatch_expand(&rule->cr.match, &match);
1838 fu.priority = rule->cr.priority;
1839 if (flags & NXFMF_ACTIONS) {
1840 fu.ofpacts = rule->ofpacts;
1841 fu.ofpacts_len = rule->ofpacts_len;
1846 ofputil_append_flow_update(&fu, &ofconn->updates);
1847 } else if (!ofconn->sent_abbrev_update) {
1848 struct ofputil_flow_update fu;
1850 fu.event = NXFME_ABBREV;
1851 fu.xid = abbrev_xid;
1852 ofputil_append_flow_update(&fu, &ofconn->updates);
1854 ofconn->sent_abbrev_update = true;
1861 ofmonitor_flush(struct connmgr *mgr)
1863 struct ofconn *ofconn;
1865 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1866 struct ofpbuf *msg, *next;
1868 LIST_FOR_EACH_SAFE (msg, next, list_node, &ofconn->updates) {
1869 list_remove(&msg->list_node);
1870 ofconn_send(ofconn, msg, ofconn->monitor_counter);
1871 if (!ofconn->monitor_paused
1872 && ofconn->monitor_counter->n_bytes > 128 * 1024) {
1873 struct ofpbuf *pause;
1875 COVERAGE_INC(ofmonitor_pause);
1876 ofconn->monitor_paused = monitor_seqno++;
1877 pause = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_PAUSED,
1878 OFP10_VERSION, htonl(0), 0);
1879 ofconn_send(ofconn, pause, ofconn->monitor_counter);
1886 ofmonitor_resume(struct ofconn *ofconn)
1888 struct ofpbuf *resumed;
1889 struct ofmonitor *m;
1894 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1895 ofmonitor_collect_resume_rules(m, ofconn->monitor_paused, &rules);
1899 ofmonitor_compose_refresh_updates(&rules, &msgs);
1901 resumed = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
1903 list_push_back(&msgs, &resumed->list_node);
1904 ofconn_send_replies(ofconn, &msgs);
1906 ofconn->monitor_paused = 0;
1910 ofmonitor_run(struct connmgr *mgr)
1912 struct ofconn *ofconn;
1914 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1915 if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1916 COVERAGE_INC(ofmonitor_resume);
1917 ofmonitor_resume(ofconn);
1923 ofmonitor_wait(struct connmgr *mgr)
1925 struct ofconn *ofconn;
1927 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1928 if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1929 poll_immediate_wake();