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,
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 static struct ofconn *find_controller_by_target(struct connmgr *,
406 static void update_fail_open(struct connmgr *);
407 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
408 const struct sset *);
410 /* Returns true if 'mgr' has any configured primary controllers.
412 * Service controllers do not count, but configured primary controllers do
413 * count whether or not they are currently connected. */
415 connmgr_has_controllers(const struct connmgr *mgr)
417 return !hmap_is_empty(&mgr->controllers);
420 /* Initializes 'info' and populates it with information about each configured
421 * primary controller. The keys in 'info' are the controllers' targets; the
422 * data values are corresponding "struct ofproto_controller_info".
424 * The caller owns 'info' and everything in it and should free it when it is no
427 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
429 const struct ofconn *ofconn;
431 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
432 const struct rconn *rconn = ofconn->rconn;
433 const char *target = rconn_get_target(rconn);
435 if (!shash_find(info, target)) {
436 struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
437 time_t now = time_now();
438 time_t last_connection = rconn_get_last_connection(rconn);
439 time_t last_disconnect = rconn_get_last_disconnect(rconn);
440 int last_error = rconn_get_last_error(rconn);
442 shash_add(info, target, cinfo);
444 cinfo->is_connected = rconn_is_connected(rconn);
445 cinfo->role = ofconn->role;
450 cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
451 cinfo->pairs.values[cinfo->pairs.n++]
452 = xstrdup(ovs_retval_to_string(last_error));
455 cinfo->pairs.keys[cinfo->pairs.n] = "state";
456 cinfo->pairs.values[cinfo->pairs.n++]
457 = xstrdup(rconn_get_state(rconn));
459 if (last_connection != TIME_MIN) {
460 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_connect";
461 cinfo->pairs.values[cinfo->pairs.n++]
462 = xasprintf("%ld", (long int) (now - last_connection));
465 if (last_disconnect != TIME_MIN) {
466 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_disconnect";
467 cinfo->pairs.values[cinfo->pairs.n++]
468 = xasprintf("%ld", (long int) (now - last_disconnect));
475 connmgr_free_controller_info(struct shash *info)
477 struct shash_node *node;
479 SHASH_FOR_EACH (node, info) {
480 struct ofproto_controller_info *cinfo = node->data;
481 while (cinfo->pairs.n) {
482 free(CONST_CAST(char *, cinfo->pairs.values[--cinfo->pairs.n]));
489 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
492 connmgr_set_controllers(struct connmgr *mgr,
493 const struct ofproto_controller *controllers,
494 size_t n_controllers)
496 bool had_controllers = connmgr_has_controllers(mgr);
497 struct shash new_controllers;
498 struct ofconn *ofconn, *next_ofconn;
499 struct ofservice *ofservice, *next_ofservice;
502 /* Create newly configured controllers and services.
503 * Create a name to ofproto_controller mapping in 'new_controllers'. */
504 shash_init(&new_controllers);
505 for (i = 0; i < n_controllers; i++) {
506 const struct ofproto_controller *c = &controllers[i];
508 if (!vconn_verify_name(c->target)) {
509 if (!find_controller_by_target(mgr, c->target)) {
510 VLOG_INFO("%s: added primary controller \"%s\"",
511 mgr->name, c->target);
512 add_controller(mgr, c->target, c->dscp);
514 } else if (!pvconn_verify_name(c->target)) {
515 if (!ofservice_lookup(mgr, c->target)) {
516 VLOG_INFO("%s: added service controller \"%s\"",
517 mgr->name, c->target);
518 ofservice_create(mgr, c->target, 0, c->dscp);
521 VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
522 mgr->name, c->target);
526 shash_add_once(&new_controllers, c->target, &controllers[i]);
529 /* Delete controllers that are no longer configured.
530 * Update configuration of all now-existing controllers. */
531 HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
532 const char *target = ofconn_get_target(ofconn);
533 struct ofproto_controller *c;
535 c = shash_find_data(&new_controllers, target);
537 VLOG_INFO("%s: removed primary controller \"%s\"",
539 ofconn_destroy(ofconn);
541 ofconn_reconfigure(ofconn, c);
545 /* Delete services that are no longer configured.
546 * Update configuration of all now-existing services. */
547 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
548 const char *target = pvconn_get_name(ofservice->pvconn);
549 struct ofproto_controller *c;
551 c = shash_find_data(&new_controllers, target);
553 VLOG_INFO("%s: removed service controller \"%s\"",
555 ofservice_destroy(mgr, ofservice);
557 ofservice_reconfigure(ofservice, c);
561 shash_destroy(&new_controllers);
563 update_in_band_remotes(mgr);
564 update_fail_open(mgr);
565 if (had_controllers != connmgr_has_controllers(mgr)) {
566 ofproto_flush_flows(mgr->ofproto);
570 /* Drops the connections between 'mgr' and all of its primary and secondary
571 * controllers, forcing them to reconnect. */
573 connmgr_reconnect(const struct connmgr *mgr)
575 struct ofconn *ofconn;
577 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
578 rconn_reconnect(ofconn->rconn);
582 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
584 * A "snoop" is a pvconn to which every OpenFlow message to or from the most
585 * important controller on 'mgr' is mirrored. */
587 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
589 return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
592 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
594 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
598 for (i = 0; i < mgr->n_snoops; i++) {
599 sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
603 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
605 connmgr_has_snoops(const struct connmgr *mgr)
607 return mgr->n_snoops > 0;
610 /* Creates a new controller for 'target' in 'mgr'. update_controller() needs
611 * to be called later to finish the new ofconn's configuration. */
613 add_controller(struct connmgr *mgr, const char *target, uint8_t dscp)
615 char *name = ofconn_make_name(mgr, target);
616 struct ofconn *ofconn;
618 ofconn = ofconn_create(mgr, rconn_create(5, 8, dscp, 0),
619 OFCONN_PRIMARY, true);
620 ofconn->pktbuf = pktbuf_create();
621 rconn_connect(ofconn->rconn, target, name);
622 hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
627 static struct ofconn *
628 find_controller_by_target(struct connmgr *mgr, const char *target)
630 struct ofconn *ofconn;
632 HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
633 hash_string(target, 0), &mgr->controllers) {
634 if (!strcmp(ofconn_get_target(ofconn), target)) {
642 update_in_band_remotes(struct connmgr *mgr)
644 struct sockaddr_in *addrs;
645 size_t max_addrs, n_addrs;
646 struct ofconn *ofconn;
649 /* Allocate enough memory for as many remotes as we could possibly have. */
650 max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
651 addrs = xmalloc(max_addrs * sizeof *addrs);
654 /* Add all the remotes. */
655 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
656 struct sockaddr_in *sin = &addrs[n_addrs];
657 const char *target = rconn_get_target(ofconn->rconn);
659 if (ofconn->band == OFPROTO_OUT_OF_BAND) {
663 if (stream_parse_target_with_default_ports(target,
670 for (i = 0; i < mgr->n_extra_remotes; i++) {
671 addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
674 /* Create or update or destroy in-band. */
677 in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
679 in_band_set_queue(mgr->in_band, mgr->in_band_queue);
681 /* in_band_run() needs a chance to delete any existing in-band flows.
682 * We will destroy mgr->in_band after it's done with that. */
685 in_band_set_remotes(mgr->in_band, addrs, n_addrs);
693 update_fail_open(struct connmgr *mgr)
695 if (connmgr_has_controllers(mgr)
696 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
697 if (!mgr->fail_open) {
698 mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
701 fail_open_destroy(mgr->fail_open);
702 mgr->fail_open = NULL;
707 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
708 const struct sset *sset)
710 struct pvconn **pvconns = *pvconnsp;
711 size_t n_pvconns = *n_pvconnsp;
716 for (i = 0; i < n_pvconns; i++) {
717 pvconn_close(pvconns[i]);
721 pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
723 SSET_FOR_EACH (name, sset) {
724 struct pvconn *pvconn;
726 error = pvconn_open(name, 0, &pvconn, 0);
728 pvconns[n_pvconns++] = pvconn;
730 VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
738 *n_pvconnsp = n_pvconns;
743 /* Returns a "preference level" for snooping 'ofconn'. A higher return value
744 * means that 'ofconn' is more interesting for monitoring than a lower return
747 snoop_preference(const struct ofconn *ofconn)
749 switch (ofconn->role) {
757 /* Shouldn't happen. */
762 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
763 * Connects this vconn to a controller. */
765 add_snooper(struct connmgr *mgr, struct vconn *vconn)
767 struct ofconn *ofconn, *best;
769 /* Pick a controller for monitoring. */
771 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
772 if (ofconn->type == OFCONN_PRIMARY
773 && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
779 rconn_add_monitor(best->rconn, vconn);
781 VLOG_INFO_RL(&rl, "no controller connection to snoop");
786 /* Public ofconn functions. */
788 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
790 ofconn_get_type(const struct ofconn *ofconn)
795 /* Returns the role configured for 'ofconn'.
797 * The default role, if no other role has been set, is NX_ROLE_OTHER. */
799 ofconn_get_role(const struct ofconn *ofconn)
804 /* Changes 'ofconn''s role to 'role'. If 'role' is NX_ROLE_MASTER then any
805 * existing master is demoted to a slave. */
807 ofconn_set_role(struct ofconn *ofconn, enum nx_role role)
809 if (role == NX_ROLE_MASTER) {
810 struct ofconn *other;
812 HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
813 if (other->role == NX_ROLE_MASTER) {
814 other->role = NX_ROLE_SLAVE;
822 ofconn_set_invalid_ttl_to_controller(struct ofconn *ofconn, bool enable)
824 uint32_t bit = 1u << OFPR_INVALID_TTL;
826 ofconn->master_async_config[OAM_PACKET_IN] |= bit;
828 ofconn->master_async_config[OAM_PACKET_IN] &= ~bit;
833 ofconn_get_invalid_ttl_to_controller(struct ofconn *ofconn)
835 uint32_t bit = 1u << OFPR_INVALID_TTL;
836 return (ofconn->master_async_config[OAM_PACKET_IN] & bit) != 0;
839 /* Returns the currently configured protocol for 'ofconn', one of OFPUTIL_P_*.
841 * The default, if no other format has been set, is OFPUTIL_P_OPENFLOW10. */
842 enum ofputil_protocol
843 ofconn_get_protocol(struct ofconn *ofconn)
845 return ofconn->protocol;
848 /* Sets the protocol for 'ofconn' to 'protocol' (one of OFPUTIL_P_*).
850 * (This doesn't actually send anything to accomplish this. Presumably the
851 * caller already did that.) */
853 ofconn_set_protocol(struct ofconn *ofconn, enum ofputil_protocol protocol)
855 ofconn->protocol = protocol;
858 /* Returns the currently configured packet in format for 'ofconn', one of
861 * The default, if no other format has been set, is NXPIF_OPENFLOW10. */
862 enum nx_packet_in_format
863 ofconn_get_packet_in_format(struct ofconn *ofconn)
865 return ofconn->packet_in_format;
868 /* Sets the packet in format for 'ofconn' to 'packet_in_format' (one of
871 ofconn_set_packet_in_format(struct ofconn *ofconn,
872 enum nx_packet_in_format packet_in_format)
874 ofconn->packet_in_format = packet_in_format;
877 /* Sets the controller connection ID for 'ofconn' to 'controller_id'.
879 * The connection controller ID is used for OFPP_CONTROLLER and
880 * NXAST_CONTROLLER actions. See "struct nx_action_controller" for details. */
882 ofconn_set_controller_id(struct ofconn *ofconn, uint16_t controller_id)
884 ofconn->controller_id = controller_id;
887 /* Returns the default miss send length for 'ofconn'. */
889 ofconn_get_miss_send_len(const struct ofconn *ofconn)
891 return ofconn->miss_send_len;
894 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
896 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
898 ofconn->miss_send_len = miss_send_len;
902 ofconn_set_async_config(struct ofconn *ofconn,
903 const uint32_t master_masks[OAM_N_TYPES],
904 const uint32_t slave_masks[OAM_N_TYPES])
906 size_t size = sizeof ofconn->master_async_config;
907 memcpy(ofconn->master_async_config, master_masks, size);
908 memcpy(ofconn->slave_async_config, slave_masks, size);
911 /* Sends 'msg' on 'ofconn', accounting it as a reply. (If there is a
912 * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
913 * connmgr will stop accepting new OpenFlow requests on that ofconn until the
914 * controller has accepted some of the replies.) */
916 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
918 ofconn_send(ofconn, msg, ofconn->reply_counter);
921 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
922 * accounting them as replies. */
924 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
926 struct ofpbuf *reply, *next;
928 LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
929 list_remove(&reply->list_node);
930 ofconn_send_reply(ofconn, reply);
934 /* Sends 'error' on 'ofconn', as a reply to 'request'. Only at most the
935 * first 64 bytes of 'request' are used. */
937 ofconn_send_error(const struct ofconn *ofconn,
938 const struct ofp_header *request, enum ofperr error)
940 struct ofpbuf *reply;
942 reply = ofperr_encode_reply(error, request);
944 static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(10, 10);
946 if (!VLOG_DROP_INFO(&err_rl)) {
947 const char *type_name;
951 request_len = ntohs(request->length);
952 type_name = (!ofpraw_decode_partial(&raw, request,
953 MIN(64, request_len))
954 ? ofpraw_get_name(raw)
957 VLOG_INFO("%s: sending %s error reply to %s message",
958 rconn_get_name(ofconn->rconn), ofperr_to_string(error),
961 ofconn_send_reply(ofconn, reply);
965 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
967 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
968 struct ofpbuf **bufferp, uint16_t *in_port)
970 return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
973 /* Returns true if 'ofconn' has any pending opgroups. */
975 ofconn_has_pending_opgroups(const struct ofconn *ofconn)
977 return !list_is_empty(&ofconn->opgroups);
980 /* Adds 'ofconn_node' to 'ofconn''s list of pending opgroups.
982 * If 'ofconn' is destroyed or its connection drops, then 'ofconn' will remove
983 * 'ofconn_node' from the list and re-initialize it with list_init(). The
984 * client may, therefore, use list_is_empty(ofconn_node) to determine whether
985 * 'ofconn_node' is still associated with an active ofconn.
987 * The client may also remove ofconn_node from the list itself, with
990 ofconn_add_opgroup(struct ofconn *ofconn, struct list *ofconn_node)
992 list_push_back(&ofconn->opgroups, ofconn_node);
995 /* Private ofconn functions. */
998 ofconn_get_target(const struct ofconn *ofconn)
1000 return rconn_get_target(ofconn->rconn);
1003 static struct ofconn *
1004 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type,
1005 bool enable_async_msgs)
1007 struct ofconn *ofconn;
1009 ofconn = xzalloc(sizeof *ofconn);
1010 ofconn->connmgr = mgr;
1011 list_push_back(&mgr->all_conns, &ofconn->node);
1012 ofconn->rconn = rconn;
1013 ofconn->type = type;
1014 ofconn->enable_async_msgs = enable_async_msgs;
1016 list_init(&ofconn->opgroups);
1018 hmap_init(&ofconn->monitors);
1019 list_init(&ofconn->updates);
1021 ofconn_flush(ofconn);
1026 /* Clears all of the state in 'ofconn' that should not persist from one
1027 * connection to the next. */
1029 ofconn_flush(struct ofconn *ofconn)
1031 struct ofmonitor *monitor, *next_monitor;
1034 ofconn->role = NX_ROLE_OTHER;
1035 ofconn->protocol = OFPUTIL_P_OF10;
1036 ofconn->packet_in_format = NXPIF_OPENFLOW10;
1038 /* Disassociate 'ofconn' from all of the ofopgroups that it initiated that
1039 * have not yet completed. (Those ofopgroups will still run to completion
1040 * in the usual way, but any errors that they run into will not be reported
1041 * on any OpenFlow channel.)
1043 * Also discard any blocked operation on 'ofconn'. */
1044 while (!list_is_empty(&ofconn->opgroups)) {
1045 list_init(list_pop_front(&ofconn->opgroups));
1047 ofpbuf_delete(ofconn->blocked);
1048 ofconn->blocked = NULL;
1050 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1051 ofconn->packet_in_counter = rconn_packet_counter_create();
1052 for (i = 0; i < N_SCHEDULERS; i++) {
1053 if (ofconn->schedulers[i]) {
1056 pinsched_get_limits(ofconn->schedulers[i], &rate, &burst);
1057 pinsched_destroy(ofconn->schedulers[i]);
1058 ofconn->schedulers[i] = pinsched_create(rate, burst);
1061 if (ofconn->pktbuf) {
1062 pktbuf_destroy(ofconn->pktbuf);
1063 ofconn->pktbuf = pktbuf_create();
1065 ofconn->miss_send_len = (ofconn->type == OFCONN_PRIMARY
1066 ? OFP_DEFAULT_MISS_SEND_LEN
1068 ofconn->controller_id = 0;
1070 rconn_packet_counter_destroy(ofconn->reply_counter);
1071 ofconn->reply_counter = rconn_packet_counter_create();
1073 if (ofconn->enable_async_msgs) {
1074 uint32_t *master = ofconn->master_async_config;
1075 uint32_t *slave = ofconn->slave_async_config;
1077 /* "master" and "other" roles get all asynchronous messages by default,
1078 * except that the controller needs to enable nonstandard "packet-in"
1079 * reasons itself. */
1080 master[OAM_PACKET_IN] = (1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION);
1081 master[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1082 | (1u << OFPPR_DELETE)
1083 | (1u << OFPPR_MODIFY));
1084 master[OAM_FLOW_REMOVED] = ((1u << OFPRR_IDLE_TIMEOUT)
1085 | (1u << OFPRR_HARD_TIMEOUT)
1086 | (1u << OFPRR_DELETE));
1088 /* "slave" role gets port status updates by default. */
1089 slave[OAM_PACKET_IN] = 0;
1090 slave[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1091 | (1u << OFPPR_DELETE)
1092 | (1u << OFPPR_MODIFY));
1093 slave[OAM_FLOW_REMOVED] = 0;
1095 memset(ofconn->master_async_config, 0,
1096 sizeof ofconn->master_async_config);
1097 memset(ofconn->slave_async_config, 0,
1098 sizeof ofconn->slave_async_config);
1101 HMAP_FOR_EACH_SAFE (monitor, next_monitor, ofconn_node,
1102 &ofconn->monitors) {
1103 ofmonitor_destroy(monitor);
1105 rconn_packet_counter_destroy(ofconn->monitor_counter);
1106 ofconn->monitor_counter = rconn_packet_counter_create();
1107 ofpbuf_list_delete(&ofconn->updates); /* ...but it should be empty. */
1111 ofconn_destroy(struct ofconn *ofconn)
1113 ofconn_flush(ofconn);
1115 if (ofconn->type == OFCONN_PRIMARY) {
1116 hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
1119 list_remove(&ofconn->node);
1120 rconn_destroy(ofconn->rconn);
1121 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1122 rconn_packet_counter_destroy(ofconn->reply_counter);
1123 pktbuf_destroy(ofconn->pktbuf);
1124 rconn_packet_counter_destroy(ofconn->monitor_counter);
1128 /* Reconfigures 'ofconn' to match 'c'. 'ofconn' and 'c' must have the same
1131 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
1135 ofconn->band = c->band;
1136 ofconn->enable_async_msgs = c->enable_async_msgs;
1138 rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
1140 probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
1141 rconn_set_probe_interval(ofconn->rconn, probe_interval);
1143 ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
1145 /* If dscp value changed reconnect. */
1146 if (c->dscp != rconn_get_dscp(ofconn->rconn)) {
1147 rconn_set_dscp(ofconn->rconn, c->dscp);
1148 rconn_reconnect(ofconn->rconn);
1152 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
1155 ofconn_may_recv(const struct ofconn *ofconn)
1157 int count = ofconn->reply_counter->n_packets;
1158 return (!ofconn->blocked || ofconn->retry) && count < OFCONN_REPLY_MAX;
1162 ofconn_run(struct ofconn *ofconn,
1163 bool (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
1165 struct connmgr *mgr = ofconn->connmgr;
1168 for (i = 0; i < N_SCHEDULERS; i++) {
1169 pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1172 rconn_run(ofconn->rconn);
1174 if (handle_openflow) {
1175 /* Limit the number of iterations to avoid starving other tasks. */
1176 for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
1177 struct ofpbuf *of_msg;
1179 of_msg = (ofconn->blocked
1181 : rconn_recv(ofconn->rconn));
1185 if (mgr->fail_open) {
1186 fail_open_maybe_recover(mgr->fail_open);
1189 if (handle_openflow(ofconn, of_msg)) {
1190 ofpbuf_delete(of_msg);
1191 ofconn->blocked = NULL;
1193 ofconn->blocked = of_msg;
1194 ofconn->retry = false;
1199 if (!rconn_is_alive(ofconn->rconn)) {
1200 ofconn_destroy(ofconn);
1201 } else if (!rconn_is_connected(ofconn->rconn)) {
1202 ofconn_flush(ofconn);
1207 ofconn_wait(struct ofconn *ofconn, bool handling_openflow)
1211 for (i = 0; i < N_SCHEDULERS; i++) {
1212 pinsched_wait(ofconn->schedulers[i]);
1214 rconn_run_wait(ofconn->rconn);
1215 if (handling_openflow && ofconn_may_recv(ofconn)) {
1216 rconn_recv_wait(ofconn->rconn);
1220 /* Returns true if 'ofconn' should receive asynchronous messages of the given
1221 * OAM_* 'type' and 'reason', which should be a OFPR_* value for OAM_PACKET_IN,
1222 * a OFPPR_* value for OAM_PORT_STATUS, or an OFPRR_* value for
1223 * OAM_FLOW_REMOVED. Returns false if the message should not be sent on
1226 ofconn_receives_async_msg(const struct ofconn *ofconn,
1227 enum ofconn_async_msg_type type,
1228 unsigned int reason)
1230 const uint32_t *async_config;
1232 assert(reason < 32);
1233 assert((unsigned int) type < OAM_N_TYPES);
1235 if (!rconn_is_connected(ofconn->rconn)) {
1239 /* Keep the following code in sync with the documentation in the
1240 * "Asynchronous Messages" section in DESIGN. */
1242 if (ofconn->type == OFCONN_SERVICE && !ofconn->miss_send_len) {
1243 /* Service connections don't get asynchronous messages unless they have
1244 * explicitly asked for them by setting a nonzero miss send length. */
1248 async_config = (ofconn->role == NX_ROLE_SLAVE
1249 ? ofconn->slave_async_config
1250 : ofconn->master_async_config);
1251 if (!(async_config[type] & (1u << reason))) {
1258 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1259 * 'target', suitable for use in log messages for identifying the connection.
1261 * The name is dynamically allocated. The caller should free it (with free())
1262 * when it is no longer needed. */
1264 ofconn_make_name(const struct connmgr *mgr, const char *target)
1266 return xasprintf("%s<->%s", mgr->name, target);
1270 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1274 for (i = 0; i < N_SCHEDULERS; i++) {
1275 struct pinsched **s = &ofconn->schedulers[i];
1279 *s = pinsched_create(rate, burst);
1281 pinsched_set_limits(*s, rate, burst);
1284 pinsched_destroy(*s);
1291 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1292 struct rconn_packet_counter *counter)
1294 ofpmsg_update_length(msg);
1295 rconn_send(ofconn->rconn, msg, counter);
1298 /* Sending asynchronous messages. */
1300 static void schedule_packet_in(struct ofconn *, struct ofputil_packet_in);
1302 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1303 * controllers managed by 'mgr'. */
1305 connmgr_send_port_status(struct connmgr *mgr,
1306 const struct ofputil_phy_port *pp, uint8_t reason)
1308 /* XXX Should limit the number of queued port status change messages. */
1309 struct ofputil_port_status ps;
1310 struct ofconn *ofconn;
1314 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1315 if (ofconn_receives_async_msg(ofconn, OAM_PORT_STATUS, reason)) {
1318 msg = ofputil_encode_port_status(&ps, ofconn->protocol);
1319 ofconn_send(ofconn, msg, NULL);
1324 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1325 * appropriate controllers managed by 'mgr'. */
1327 connmgr_send_flow_removed(struct connmgr *mgr,
1328 const struct ofputil_flow_removed *fr)
1330 struct ofconn *ofconn;
1332 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1333 if (ofconn_receives_async_msg(ofconn, OAM_FLOW_REMOVED, fr->reason)) {
1336 /* Account flow expirations as replies to OpenFlow requests. That
1337 * works because preventing OpenFlow requests from being processed
1338 * also prevents new flows from being added (and expiring). (It
1339 * also prevents processing OpenFlow requests that would not add
1340 * new flows, so it is imperfect.) */
1341 msg = ofputil_encode_flow_removed(fr, ofconn->protocol);
1342 ofconn_send_reply(ofconn, msg);
1347 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1348 * necessary according to their individual configurations.
1350 * The caller doesn't need to fill in pin->buffer_id or pin->total_len. */
1352 connmgr_send_packet_in(struct connmgr *mgr,
1353 const struct ofputil_packet_in *pin)
1355 struct ofconn *ofconn;
1357 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1358 if (ofconn_receives_async_msg(ofconn, OAM_PACKET_IN, pin->reason)
1359 && ofconn->controller_id == pin->controller_id) {
1360 schedule_packet_in(ofconn, *pin);
1365 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1367 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1369 struct ofconn *ofconn = ofconn_;
1371 rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1372 ofconn->packet_in_counter, 100);
1375 /* Takes 'pin', composes an OpenFlow packet-in message from it, and passes it
1376 * to 'ofconn''s packet scheduler for sending. */
1378 schedule_packet_in(struct ofconn *ofconn, struct ofputil_packet_in pin)
1380 struct connmgr *mgr = ofconn->connmgr;
1382 pin.total_len = pin.packet_len;
1384 /* Get OpenFlow buffer_id. */
1385 if (pin.reason == OFPR_ACTION) {
1386 pin.buffer_id = UINT32_MAX;
1387 } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1388 pin.buffer_id = pktbuf_get_null();
1389 } else if (!ofconn->pktbuf) {
1390 pin.buffer_id = UINT32_MAX;
1392 pin.buffer_id = pktbuf_save(ofconn->pktbuf, pin.packet, pin.packet_len,
1396 /* Figure out how much of the packet to send. */
1397 if (pin.reason == OFPR_NO_MATCH) {
1398 pin.send_len = pin.packet_len;
1400 /* Caller should have initialized 'send_len' to 'max_len' specified in
1403 if (pin.buffer_id != UINT32_MAX) {
1404 pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1407 /* Make OFPT_PACKET_IN and hand over to packet scheduler. It might
1408 * immediately call into do_send_packet_in() or it might buffer it for a
1409 * while (until a later call to pinsched_run()). */
1410 pinsched_send(ofconn->schedulers[pin.reason == OFPR_NO_MATCH ? 0 : 1],
1412 ofputil_encode_packet_in(&pin, ofconn->protocol,
1413 ofconn->packet_in_format),
1414 do_send_packet_in, ofconn);
1417 /* Fail-open settings. */
1419 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1420 * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1421 enum ofproto_fail_mode
1422 connmgr_get_fail_mode(const struct connmgr *mgr)
1424 return mgr->fail_mode;
1427 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1428 * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1430 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1432 if (mgr->fail_mode != fail_mode) {
1433 mgr->fail_mode = fail_mode;
1434 update_fail_open(mgr);
1435 if (!connmgr_has_controllers(mgr)) {
1436 ofproto_flush_flows(mgr->ofproto);
1441 /* Fail-open implementation. */
1443 /* Returns the longest probe interval among the primary controllers configured
1444 * on 'mgr'. Returns 0 if there are no primary controllers. */
1446 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1448 const struct ofconn *ofconn;
1449 int max_probe_interval;
1451 max_probe_interval = 0;
1452 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1453 int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1454 max_probe_interval = MAX(max_probe_interval, probe_interval);
1456 return max_probe_interval;
1459 /* Returns the number of seconds for which all of 'mgr's primary controllers
1460 * have been disconnected. Returns 0 if 'mgr' has no primary controllers. */
1462 connmgr_failure_duration(const struct connmgr *mgr)
1464 const struct ofconn *ofconn;
1465 int min_failure_duration;
1467 if (!connmgr_has_controllers(mgr)) {
1471 min_failure_duration = INT_MAX;
1472 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1473 int failure_duration = rconn_failure_duration(ofconn->rconn);
1474 min_failure_duration = MIN(min_failure_duration, failure_duration);
1476 return min_failure_duration;
1479 /* Returns true if at least one primary controller is connected (regardless of
1480 * whether those controllers are believed to have authenticated and accepted
1481 * this switch), false if none of them are connected. */
1483 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1485 const struct ofconn *ofconn;
1487 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1488 if (rconn_is_connected(ofconn->rconn)) {
1495 /* Returns true if at least one primary controller is believed to have
1496 * authenticated and accepted this switch, false otherwise. */
1498 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1500 const struct ofconn *ofconn;
1502 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1503 if (rconn_is_admitted(ofconn->rconn)) {
1510 /* In-band configuration. */
1512 static bool any_extras_changed(const struct connmgr *,
1513 const struct sockaddr_in *extras, size_t n);
1515 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1516 * in-band control should guarantee access, in the same way that in-band
1517 * control guarantees access to OpenFlow controllers. */
1519 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1520 const struct sockaddr_in *extras, size_t n)
1522 if (!any_extras_changed(mgr, extras, n)) {
1526 free(mgr->extra_in_band_remotes);
1527 mgr->n_extra_remotes = n;
1528 mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1530 update_in_band_remotes(mgr);
1533 /* Sets the OpenFlow queue used by flows set up by in-band control on
1534 * 'mgr' to 'queue_id'. If 'queue_id' is negative, then in-band control
1535 * flows will use the default queue. */
1537 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1539 if (queue_id != mgr->in_band_queue) {
1540 mgr->in_band_queue = queue_id;
1541 update_in_band_remotes(mgr);
1546 any_extras_changed(const struct connmgr *mgr,
1547 const struct sockaddr_in *extras, size_t n)
1551 if (n != mgr->n_extra_remotes) {
1555 for (i = 0; i < n; i++) {
1556 const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1557 const struct sockaddr_in *new = &extras[i];
1559 if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1560 old->sin_port != new->sin_port) {
1568 /* In-band implementation. */
1571 connmgr_msg_in_hook(struct connmgr *mgr, const struct flow *flow,
1572 const struct ofpbuf *packet)
1574 return mgr->in_band && in_band_msg_in_hook(mgr->in_band, flow, packet);
1578 connmgr_may_set_up_flow(struct connmgr *mgr, const struct flow *flow,
1579 const struct nlattr *odp_actions,
1582 return !mgr->in_band || in_band_rule_check(flow, odp_actions, actions_len);
1585 /* Fail-open and in-band implementation. */
1587 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1588 * and standalone mode to re-create their flows.
1590 * In-band control has more sophisticated code that manages flows itself. */
1592 connmgr_flushed(struct connmgr *mgr)
1594 if (mgr->fail_open) {
1595 fail_open_flushed(mgr->fail_open);
1598 /* If there are no controllers and we're in standalone mode, set up a flow
1599 * that matches every packet and directs them to OFPP_NORMAL (which goes to
1600 * us). Otherwise, the switch is in secure mode and we won't pass any
1601 * traffic until a controller has been defined and it tells us to do so. */
1602 if (!connmgr_has_controllers(mgr)
1603 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1604 struct ofpbuf ofpacts;
1607 ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
1608 ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
1609 ofpact_pad(&ofpacts);
1611 match_init_catchall(&match);
1612 ofproto_add_flow(mgr->ofproto, &match, 0, ofpacts.data, ofpacts.size);
1614 ofpbuf_uninit(&ofpacts);
1618 /* Creates a new ofservice for 'target' in 'mgr'. Returns 0 if successful,
1619 * otherwise a positive errno value.
1621 * ofservice_reconfigure() must be called to fully configure the new
1624 ofservice_create(struct connmgr *mgr, const char *target,
1625 uint32_t allowed_versions, uint8_t dscp)
1627 struct ofservice *ofservice;
1628 struct pvconn *pvconn;
1631 error = pvconn_open(target, allowed_versions, &pvconn, dscp);
1636 ofservice = xzalloc(sizeof *ofservice);
1637 hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1638 ofservice->pvconn = pvconn;
1644 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1646 hmap_remove(&mgr->services, &ofservice->node);
1647 pvconn_close(ofservice->pvconn);
1652 ofservice_reconfigure(struct ofservice *ofservice,
1653 const struct ofproto_controller *c)
1655 ofservice->probe_interval = c->probe_interval;
1656 ofservice->rate_limit = c->rate_limit;
1657 ofservice->burst_limit = c->burst_limit;
1658 ofservice->enable_async_msgs = c->enable_async_msgs;
1659 ofservice->dscp = c->dscp;
1662 /* Finds and returns the ofservice within 'mgr' that has the given
1663 * 'target', or a null pointer if none exists. */
1664 static struct ofservice *
1665 ofservice_lookup(struct connmgr *mgr, const char *target)
1667 struct ofservice *ofservice;
1669 HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1671 if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1678 /* Flow monitors (NXST_FLOW_MONITOR). */
1680 /* A counter incremented when something significant happens to an OpenFlow
1683 * - When a rule is added, its 'add_seqno' and 'modify_seqno' are set to
1684 * the current value (which is then incremented).
1686 * - When a rule is modified, its 'modify_seqno' is set to the current
1687 * value (which is then incremented).
1689 * Thus, by comparing an old value of monitor_seqno against a rule's
1690 * 'add_seqno', one can tell whether the rule was added before or after the old
1691 * value was read, and similarly for 'modify_seqno'.
1693 * 32 bits should normally be sufficient (and would be nice, to save space in
1694 * each rule) but then we'd have to have some special cases for wraparound.
1696 * We initialize monitor_seqno to 1 to allow 0 to be used as an invalid
1698 static uint64_t monitor_seqno = 1;
1700 COVERAGE_DEFINE(ofmonitor_pause);
1701 COVERAGE_DEFINE(ofmonitor_resume);
1704 ofmonitor_create(const struct ofputil_flow_monitor_request *request,
1705 struct ofconn *ofconn, struct ofmonitor **monitorp)
1707 struct ofmonitor *m;
1711 m = ofmonitor_lookup(ofconn, request->id);
1713 return OFPERR_NXBRC_FM_DUPLICATE_ID;
1716 m = xmalloc(sizeof *m);
1718 hmap_insert(&ofconn->monitors, &m->ofconn_node, hash_int(request->id, 0));
1719 m->id = request->id;
1720 m->flags = request->flags;
1721 m->out_port = request->out_port;
1722 m->table_id = request->table_id;
1723 minimatch_init(&m->match, &request->match);
1730 ofmonitor_lookup(struct ofconn *ofconn, uint32_t id)
1732 struct ofmonitor *m;
1734 HMAP_FOR_EACH_IN_BUCKET (m, ofconn_node, hash_int(id, 0),
1735 &ofconn->monitors) {
1744 ofmonitor_destroy(struct ofmonitor *m)
1747 hmap_remove(&m->ofconn->monitors, &m->ofconn_node);
1753 ofmonitor_report(struct connmgr *mgr, struct rule *rule,
1754 enum nx_flow_update_event event,
1755 enum ofp_flow_removed_reason reason,
1756 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
1758 enum nx_flow_monitor_flags update;
1759 struct ofconn *ofconn;
1764 rule->add_seqno = rule->modify_seqno = monitor_seqno++;
1768 update = NXFMF_DELETE;
1771 case NXFME_MODIFIED:
1772 update = NXFMF_MODIFY;
1773 rule->modify_seqno = monitor_seqno++;
1781 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1782 enum nx_flow_monitor_flags flags = 0;
1783 struct ofmonitor *m;
1785 if (ofconn->monitor_paused) {
1786 /* Only send NXFME_DELETED notifications for flows that were added
1787 * before we paused. */
1788 if (event != NXFME_DELETED
1789 || rule->add_seqno > ofconn->monitor_paused) {
1794 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1795 if (m->flags & update
1796 && (m->table_id == 0xff || m->table_id == rule->table_id)
1797 && ofoperation_has_out_port(rule->pending, m->out_port)
1798 && cls_rule_is_loose_match(&rule->cr, &m->match)) {
1804 if (list_is_empty(&ofconn->updates)) {
1805 ofputil_start_flow_update(&ofconn->updates);
1806 ofconn->sent_abbrev_update = false;
1809 if (ofconn != abbrev_ofconn || ofconn->monitor_paused) {
1810 struct ofputil_flow_update fu;
1814 fu.reason = event == NXFME_DELETED ? reason : 0;
1815 fu.idle_timeout = rule->idle_timeout;
1816 fu.hard_timeout = rule->hard_timeout;
1817 fu.table_id = rule->table_id;
1818 fu.cookie = rule->flow_cookie;
1819 minimatch_expand(&rule->cr.match, &match);
1821 fu.priority = rule->cr.priority;
1822 if (flags & NXFMF_ACTIONS) {
1823 fu.ofpacts = rule->ofpacts;
1824 fu.ofpacts_len = rule->ofpacts_len;
1829 ofputil_append_flow_update(&fu, &ofconn->updates);
1830 } else if (!ofconn->sent_abbrev_update) {
1831 struct ofputil_flow_update fu;
1833 fu.event = NXFME_ABBREV;
1834 fu.xid = abbrev_xid;
1835 ofputil_append_flow_update(&fu, &ofconn->updates);
1837 ofconn->sent_abbrev_update = true;
1844 ofmonitor_flush(struct connmgr *mgr)
1846 struct ofconn *ofconn;
1848 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1849 struct ofpbuf *msg, *next;
1851 LIST_FOR_EACH_SAFE (msg, next, list_node, &ofconn->updates) {
1852 list_remove(&msg->list_node);
1853 ofconn_send(ofconn, msg, ofconn->monitor_counter);
1854 if (!ofconn->monitor_paused
1855 && ofconn->monitor_counter->n_bytes > 128 * 1024) {
1856 struct ofpbuf *pause;
1858 COVERAGE_INC(ofmonitor_pause);
1859 ofconn->monitor_paused = monitor_seqno++;
1860 pause = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_PAUSED,
1861 OFP10_VERSION, htonl(0), 0);
1862 ofconn_send(ofconn, pause, ofconn->monitor_counter);
1869 ofmonitor_resume(struct ofconn *ofconn)
1871 struct ofpbuf *resumed;
1872 struct ofmonitor *m;
1877 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1878 ofmonitor_collect_resume_rules(m, ofconn->monitor_paused, &rules);
1882 ofmonitor_compose_refresh_updates(&rules, &msgs);
1884 resumed = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
1886 list_push_back(&msgs, &resumed->list_node);
1887 ofconn_send_replies(ofconn, &msgs);
1889 ofconn->monitor_paused = 0;
1893 ofmonitor_run(struct connmgr *mgr)
1895 struct ofconn *ofconn;
1897 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1898 if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1899 COVERAGE_INC(ofmonitor_resume);
1900 ofmonitor_resume(ofconn);
1906 ofmonitor_wait(struct connmgr *mgr)
1908 struct ofconn *ofconn;
1910 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1911 if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1912 poll_immediate_wake();