2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
25 #include "fail-open.h"
28 #include "ofp-actions.h"
32 #include "ofproto-provider.h"
34 #include "poll-loop.h"
44 VLOG_DEFINE_THIS_MODULE(connmgr);
45 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
47 /* An OpenFlow connection.
53 * 'ofproto_mutex' must be held whenever an ofconn is created or destroyed or,
54 * more or less equivalently, whenever an ofconn is added to or removed from a
55 * connmgr. 'ofproto_mutex' doesn't protect the data inside the ofconn, except
56 * as specifically noted below. */
58 /* Configuration that persists from one connection to the next. */
60 struct list node; /* In struct connmgr's "all_conns" list. */
61 struct hmap_node hmap_node; /* In struct connmgr's "controllers" map. */
63 struct connmgr *connmgr; /* Connection's manager. */
64 struct rconn *rconn; /* OpenFlow connection. */
65 enum ofconn_type type; /* Type. */
66 enum ofproto_band band; /* In-band or out-of-band? */
67 bool enable_async_msgs; /* Initially enable async messages? */
69 /* State that should be cleared from one connection to the next. */
72 enum ofp12_controller_role role; /* Role. */
73 enum ofputil_protocol protocol; /* Current protocol variant. */
74 enum nx_packet_in_format packet_in_format; /* OFPT_PACKET_IN format. */
76 /* Asynchronous flow table operation support. */
77 struct list opgroups; /* Contains pending "ofopgroups", if any. */
78 struct ofpbuf *blocked; /* Postponed OpenFlow message, if any. */
79 bool retry; /* True if 'blocked' is ready to try again. */
81 /* OFPT_PACKET_IN related data. */
82 struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
83 #define N_SCHEDULERS 2
84 struct pinsched *schedulers[N_SCHEDULERS];
85 struct pktbuf *pktbuf; /* OpenFlow packet buffers. */
86 int miss_send_len; /* Bytes to send of buffered packets. */
87 uint16_t controller_id; /* Connection controller ID. */
89 /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
90 * requests, and the maximum number before we stop reading OpenFlow
92 #define OFCONN_REPLY_MAX 100
93 struct rconn_packet_counter *reply_counter;
95 /* Asynchronous message configuration in each possible roles.
97 * A 1-bit enables sending an asynchronous message for one possible reason
98 * that the message might be generated, a 0-bit disables it. */
99 uint32_t master_async_config[OAM_N_TYPES]; /* master, other */
100 uint32_t slave_async_config[OAM_N_TYPES]; /* slave */
102 /* Flow monitors (e.g. NXST_FLOW_MONITOR). */
104 /* Configuration. Contains "struct ofmonitor"s. */
105 struct hmap monitors OVS_GUARDED_BY(ofproto_mutex);
109 * When too many flow monitor notifications back up in the transmit buffer,
110 * we pause the transmission of further notifications. These members track
111 * the flow control state.
113 * When notifications are flowing, 'monitor_paused' is 0. When
114 * notifications are paused, 'monitor_paused' is the value of
115 * 'monitor_seqno' at the point we paused.
117 * 'monitor_counter' counts the OpenFlow messages and bytes currently in
118 * flight. This value growing too large triggers pausing. */
119 uint64_t monitor_paused OVS_GUARDED_BY(ofproto_mutex);
120 struct rconn_packet_counter *monitor_counter OVS_GUARDED_BY(ofproto_mutex);
122 /* State of monitors for a single ongoing flow_mod.
124 * 'updates' is a list of "struct ofpbuf"s that contain
125 * NXST_FLOW_MONITOR_REPLY messages representing the changes made by the
128 * When 'updates' is nonempty, 'sent_abbrev_update' is true if 'updates'
129 * contains an update event of type NXFME_ABBREV and false otherwise.. */
130 struct list updates OVS_GUARDED_BY(ofproto_mutex);
131 bool sent_abbrev_update OVS_GUARDED_BY(ofproto_mutex);
134 static struct ofconn *ofconn_create(struct connmgr *, struct rconn *,
135 enum ofconn_type, bool enable_async_msgs)
136 OVS_REQUIRES(ofproto_mutex);
137 static void ofconn_destroy(struct ofconn *) OVS_REQUIRES(ofproto_mutex);
138 static void ofconn_flush(struct ofconn *) OVS_REQUIRES(ofproto_mutex);
140 static void ofconn_reconfigure(struct ofconn *,
141 const struct ofproto_controller *);
143 static void ofconn_run(struct ofconn *,
144 bool (*handle_openflow)(struct ofconn *,
145 const struct ofpbuf *ofp_msg));
146 static void ofconn_wait(struct ofconn *, bool handling_openflow);
148 static const char *ofconn_get_target(const struct ofconn *);
149 static char *ofconn_make_name(const struct connmgr *, const char *target);
151 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
153 static void ofconn_send(const struct ofconn *, struct ofpbuf *,
154 struct rconn_packet_counter *);
156 static void do_send_packet_ins(struct ofconn *, struct list *txq);
158 /* A listener for incoming OpenFlow "service" connections. */
160 struct hmap_node node; /* In struct connmgr's "services" hmap. */
161 struct pvconn *pvconn; /* OpenFlow connection listener. */
163 /* These are not used by ofservice directly. They are settings for
164 * accepted "struct ofconn"s from the pvconn. */
165 int probe_interval; /* Max idle time before probing, in seconds. */
166 int rate_limit; /* Max packet-in rate in packets per second. */
167 int burst_limit; /* Limit on accumulating packet credits. */
168 bool enable_async_msgs; /* Initially enable async messages? */
169 uint8_t dscp; /* DSCP Value for controller connection */
170 uint32_t allowed_versions; /* OpenFlow protocol versions that may
171 * be negotiated for a session. */
174 static void ofservice_reconfigure(struct ofservice *,
175 const struct ofproto_controller *);
176 static int ofservice_create(struct connmgr *mgr, const char *target,
177 uint32_t allowed_versions, uint8_t dscp);
178 static void ofservice_destroy(struct connmgr *, struct ofservice *);
179 static struct ofservice *ofservice_lookup(struct connmgr *,
182 /* Connection manager for an OpenFlow switch. */
184 struct ofproto *ofproto;
186 char *local_port_name;
188 /* OpenFlow connections. */
189 struct hmap controllers; /* Controller "struct ofconn"s. */
190 struct list all_conns; /* Contains "struct ofconn"s. */
191 uint64_t master_election_id; /* monotonically increasing sequence number
192 * for master election */
193 bool master_election_id_defined;
195 /* OpenFlow listeners. */
196 struct hmap services; /* Contains "struct ofservice"s. */
197 struct pvconn **snoops;
201 struct fail_open *fail_open;
202 enum ofproto_fail_mode fail_mode;
204 /* In-band control. */
205 struct in_band *in_band;
206 struct sockaddr_in *extra_in_band_remotes;
207 size_t n_extra_remotes;
211 static void update_in_band_remotes(struct connmgr *);
212 static void add_snooper(struct connmgr *, struct vconn *);
213 static void ofmonitor_run(struct connmgr *);
214 static void ofmonitor_wait(struct connmgr *);
216 /* Creates and returns a new connection manager owned by 'ofproto'. 'name' is
217 * a name for the ofproto suitable for using in log messages.
218 * 'local_port_name' is the name of the local port (OFPP_LOCAL) within
221 connmgr_create(struct ofproto *ofproto,
222 const char *name, const char *local_port_name)
226 mgr = xmalloc(sizeof *mgr);
227 mgr->ofproto = ofproto;
228 mgr->name = xstrdup(name);
229 mgr->local_port_name = xstrdup(local_port_name);
231 hmap_init(&mgr->controllers);
232 list_init(&mgr->all_conns);
233 mgr->master_election_id = 0;
234 mgr->master_election_id_defined = false;
236 hmap_init(&mgr->services);
240 mgr->fail_open = NULL;
241 mgr->fail_mode = OFPROTO_FAIL_SECURE;
244 mgr->extra_in_band_remotes = NULL;
245 mgr->n_extra_remotes = 0;
246 mgr->in_band_queue = -1;
251 /* Frees 'mgr' and all of its resources. */
253 connmgr_destroy(struct connmgr *mgr)
255 struct ofservice *ofservice, *next_ofservice;
256 struct ofconn *ofconn, *next_ofconn;
263 ovs_mutex_lock(&ofproto_mutex);
264 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
265 ofconn_destroy(ofconn);
267 ovs_mutex_unlock(&ofproto_mutex);
269 hmap_destroy(&mgr->controllers);
271 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
272 ofservice_destroy(mgr, ofservice);
274 hmap_destroy(&mgr->services);
276 for (i = 0; i < mgr->n_snoops; i++) {
277 pvconn_close(mgr->snoops[i]);
281 fail_open_destroy(mgr->fail_open);
282 mgr->fail_open = NULL;
284 in_band_destroy(mgr->in_band);
286 free(mgr->extra_in_band_remotes);
288 free(mgr->local_port_name);
293 /* Does all of the periodic maintenance required by 'mgr'.
295 * If 'handle_openflow' is nonnull, calls 'handle_openflow' for each message
296 * received on an OpenFlow connection, passing along the OpenFlow connection
297 * itself and the message that was sent. If 'handle_openflow' returns true,
298 * the message is considered to be fully processed. If 'handle_openflow'
299 * returns false, the message is considered not to have been processed at all;
300 * it will be stored and re-presented to 'handle_openflow' following the next
301 * call to connmgr_retry(). 'handle_openflow' must not modify or free the
304 * If 'handle_openflow' is NULL, no OpenFlow messages will be processed and
305 * other activities that could affect the flow table (in-band processing,
306 * fail-open processing) are suppressed too. */
308 connmgr_run(struct connmgr *mgr,
309 bool (*handle_openflow)(struct ofconn *,
310 const struct ofpbuf *ofp_msg))
311 OVS_EXCLUDED(ofproto_mutex)
313 struct ofconn *ofconn, *next_ofconn;
314 struct ofservice *ofservice;
317 if (handle_openflow && mgr->in_band) {
318 if (!in_band_run(mgr->in_band)) {
319 in_band_destroy(mgr->in_band);
324 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
325 ofconn_run(ofconn, handle_openflow);
329 /* Fail-open maintenance. Do this after processing the ofconns since
330 * fail-open checks the status of the controller rconn. */
331 if (handle_openflow && mgr->fail_open) {
332 fail_open_run(mgr->fail_open);
335 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
339 retval = pvconn_accept(ofservice->pvconn, &vconn);
344 /* Passing default value for creation of the rconn */
345 rconn = rconn_create(ofservice->probe_interval, 0, ofservice->dscp,
346 vconn_get_allowed_versions(vconn));
347 name = ofconn_make_name(mgr, vconn_get_name(vconn));
348 rconn_connect_unreliably(rconn, vconn, name);
351 ovs_mutex_lock(&ofproto_mutex);
352 ofconn = ofconn_create(mgr, rconn, OFCONN_SERVICE,
353 ofservice->enable_async_msgs);
354 ovs_mutex_unlock(&ofproto_mutex);
356 ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
357 ofservice->burst_limit);
358 } else if (retval != EAGAIN) {
359 VLOG_WARN_RL(&rl, "accept failed (%s)", ovs_strerror(retval));
363 for (i = 0; i < mgr->n_snoops; i++) {
367 retval = pvconn_accept(mgr->snoops[i], &vconn);
369 add_snooper(mgr, vconn);
370 } else if (retval != EAGAIN) {
371 VLOG_WARN_RL(&rl, "accept failed (%s)", ovs_strerror(retval));
376 /* Causes the poll loop to wake up when connmgr_run() needs to run.
378 * If 'handling_openflow' is true, arriving OpenFlow messages and other
379 * activities that affect the flow table will wake up the poll loop. If
380 * 'handling_openflow' is false, they will not. */
382 connmgr_wait(struct connmgr *mgr, bool handling_openflow)
384 struct ofservice *ofservice;
385 struct ofconn *ofconn;
388 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
389 ofconn_wait(ofconn, handling_openflow);
392 if (handling_openflow && mgr->in_band) {
393 in_band_wait(mgr->in_band);
395 if (handling_openflow && mgr->fail_open) {
396 fail_open_wait(mgr->fail_open);
398 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
399 pvconn_wait(ofservice->pvconn);
401 for (i = 0; i < mgr->n_snoops; i++) {
402 pvconn_wait(mgr->snoops[i]);
406 /* Adds some memory usage statistics for 'mgr' into 'usage', for use with
407 * memory_report(). */
409 connmgr_get_memory_usage(const struct connmgr *mgr, struct simap *usage)
411 const struct ofconn *ofconn;
412 unsigned int packets = 0;
413 unsigned int ofconns = 0;
415 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
420 packets += rconn_count_txqlen(ofconn->rconn);
421 for (i = 0; i < N_SCHEDULERS; i++) {
422 packets += pinsched_count_txqlen(ofconn->schedulers[i]);
424 packets += pktbuf_count_packets(ofconn->pktbuf);
426 simap_increase(usage, "ofconns", ofconns);
427 simap_increase(usage, "packets", packets);
430 /* Returns the ofproto that owns 'ofconn''s connmgr. */
432 ofconn_get_ofproto(const struct ofconn *ofconn)
434 return ofconn->connmgr->ofproto;
437 /* If processing of OpenFlow messages was blocked on any 'mgr' ofconns by
438 * returning false to the 'handle_openflow' callback to connmgr_run(), this
439 * re-enables them. */
441 connmgr_retry(struct connmgr *mgr)
443 struct ofconn *ofconn;
445 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
446 ofconn->retry = true;
450 /* OpenFlow configuration. */
452 static void add_controller(struct connmgr *, const char *target, uint8_t dscp,
453 uint32_t allowed_versions)
454 OVS_REQUIRES(ofproto_mutex);
455 static struct ofconn *find_controller_by_target(struct connmgr *,
457 static void update_fail_open(struct connmgr *);
458 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
459 const struct sset *);
461 /* Returns true if 'mgr' has any configured primary controllers.
463 * Service controllers do not count, but configured primary controllers do
464 * count whether or not they are currently connected. */
466 connmgr_has_controllers(const struct connmgr *mgr)
468 return !hmap_is_empty(&mgr->controllers);
471 /* Initializes 'info' and populates it with information about each configured
472 * primary controller. The keys in 'info' are the controllers' targets; the
473 * data values are corresponding "struct ofproto_controller_info".
475 * The caller owns 'info' and everything in it and should free it when it is no
478 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
480 const struct ofconn *ofconn;
482 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
483 const struct rconn *rconn = ofconn->rconn;
484 const char *target = rconn_get_target(rconn);
486 if (!shash_find(info, target)) {
487 struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
488 time_t now = time_now();
489 time_t last_connection = rconn_get_last_connection(rconn);
490 time_t last_disconnect = rconn_get_last_disconnect(rconn);
491 int last_error = rconn_get_last_error(rconn);
493 shash_add(info, target, cinfo);
495 cinfo->is_connected = rconn_is_connected(rconn);
496 cinfo->role = ofconn->role;
501 cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
502 cinfo->pairs.values[cinfo->pairs.n++]
503 = xstrdup(ovs_retval_to_string(last_error));
506 cinfo->pairs.keys[cinfo->pairs.n] = "state";
507 cinfo->pairs.values[cinfo->pairs.n++]
508 = xstrdup(rconn_get_state(rconn));
510 if (last_connection != TIME_MIN) {
511 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_connect";
512 cinfo->pairs.values[cinfo->pairs.n++]
513 = xasprintf("%ld", (long int) (now - last_connection));
516 if (last_disconnect != TIME_MIN) {
517 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_disconnect";
518 cinfo->pairs.values[cinfo->pairs.n++]
519 = xasprintf("%ld", (long int) (now - last_disconnect));
526 connmgr_free_controller_info(struct shash *info)
528 struct shash_node *node;
530 SHASH_FOR_EACH (node, info) {
531 struct ofproto_controller_info *cinfo = node->data;
532 while (cinfo->pairs.n) {
533 free(CONST_CAST(char *, cinfo->pairs.values[--cinfo->pairs.n]));
540 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
543 connmgr_set_controllers(struct connmgr *mgr,
544 const struct ofproto_controller *controllers,
545 size_t n_controllers, uint32_t allowed_versions)
546 OVS_EXCLUDED(ofproto_mutex)
548 bool had_controllers = connmgr_has_controllers(mgr);
549 struct shash new_controllers;
550 struct ofconn *ofconn, *next_ofconn;
551 struct ofservice *ofservice, *next_ofservice;
554 /* Required to add and remove ofconns. This could probably be narrowed to
555 * cover a smaller amount of code, if that yielded some benefit. */
556 ovs_mutex_lock(&ofproto_mutex);
558 /* Create newly configured controllers and services.
559 * Create a name to ofproto_controller mapping in 'new_controllers'. */
560 shash_init(&new_controllers);
561 for (i = 0; i < n_controllers; i++) {
562 const struct ofproto_controller *c = &controllers[i];
564 if (!vconn_verify_name(c->target)) {
566 ofconn = find_controller_by_target(mgr, c->target);
568 VLOG_INFO("%s: added primary controller \"%s\"",
569 mgr->name, c->target);
571 } else if (rconn_get_allowed_versions(ofconn->rconn) !=
573 VLOG_INFO("%s: re-added primary controller \"%s\"",
574 mgr->name, c->target);
576 ofconn_destroy(ofconn);
579 add_controller(mgr, c->target, c->dscp, allowed_versions);
581 } else if (!pvconn_verify_name(c->target)) {
583 ofservice = ofservice_lookup(mgr, c->target);
585 VLOG_INFO("%s: added service controller \"%s\"",
586 mgr->name, c->target);
588 } else if (ofservice->allowed_versions != allowed_versions) {
589 VLOG_INFO("%s: re-added service controller \"%s\"",
590 mgr->name, c->target);
591 ofservice_destroy(mgr, ofservice);
595 ofservice_create(mgr, c->target, allowed_versions, c->dscp);
598 VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
599 mgr->name, c->target);
603 shash_add_once(&new_controllers, c->target, &controllers[i]);
606 /* Delete controllers that are no longer configured.
607 * Update configuration of all now-existing controllers. */
608 HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
609 const char *target = ofconn_get_target(ofconn);
610 struct ofproto_controller *c;
612 c = shash_find_data(&new_controllers, target);
614 VLOG_INFO("%s: removed primary controller \"%s\"",
616 ofconn_destroy(ofconn);
618 ofconn_reconfigure(ofconn, c);
622 /* Delete services that are no longer configured.
623 * Update configuration of all now-existing services. */
624 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
625 const char *target = pvconn_get_name(ofservice->pvconn);
626 struct ofproto_controller *c;
628 c = shash_find_data(&new_controllers, target);
630 VLOG_INFO("%s: removed service controller \"%s\"",
632 ofservice_destroy(mgr, ofservice);
634 ofservice_reconfigure(ofservice, c);
638 shash_destroy(&new_controllers);
640 update_in_band_remotes(mgr);
641 update_fail_open(mgr);
642 if (had_controllers != connmgr_has_controllers(mgr)) {
643 ofproto_flush_flows(mgr->ofproto);
645 ovs_mutex_unlock(&ofproto_mutex);
648 /* Drops the connections between 'mgr' and all of its primary and secondary
649 * controllers, forcing them to reconnect. */
651 connmgr_reconnect(const struct connmgr *mgr)
653 struct ofconn *ofconn;
655 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
656 rconn_reconnect(ofconn->rconn);
660 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
662 * A "snoop" is a pvconn to which every OpenFlow message to or from the most
663 * important controller on 'mgr' is mirrored. */
665 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
667 return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
670 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
672 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
676 for (i = 0; i < mgr->n_snoops; i++) {
677 sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
681 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
683 connmgr_has_snoops(const struct connmgr *mgr)
685 return mgr->n_snoops > 0;
688 /* Creates a new controller for 'target' in 'mgr'. update_controller() needs
689 * to be called later to finish the new ofconn's configuration. */
691 add_controller(struct connmgr *mgr, const char *target, uint8_t dscp,
692 uint32_t allowed_versions)
693 OVS_REQUIRES(ofproto_mutex)
695 char *name = ofconn_make_name(mgr, target);
696 struct ofconn *ofconn;
698 ofconn = ofconn_create(mgr, rconn_create(5, 8, dscp, allowed_versions),
699 OFCONN_PRIMARY, true);
700 ofconn->pktbuf = pktbuf_create();
701 rconn_connect(ofconn->rconn, target, name);
702 hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
707 static struct ofconn *
708 find_controller_by_target(struct connmgr *mgr, const char *target)
710 struct ofconn *ofconn;
712 HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
713 hash_string(target, 0), &mgr->controllers) {
714 if (!strcmp(ofconn_get_target(ofconn), target)) {
722 update_in_band_remotes(struct connmgr *mgr)
724 struct sockaddr_in *addrs;
725 size_t max_addrs, n_addrs;
726 struct ofconn *ofconn;
729 /* Allocate enough memory for as many remotes as we could possibly have. */
730 max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
731 addrs = xmalloc(max_addrs * sizeof *addrs);
734 /* Add all the remotes. */
735 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
736 struct sockaddr_in *sin = &addrs[n_addrs];
737 const char *target = rconn_get_target(ofconn->rconn);
739 if (ofconn->band == OFPROTO_OUT_OF_BAND) {
743 if (stream_parse_target_with_default_port(target,
749 for (i = 0; i < mgr->n_extra_remotes; i++) {
750 addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
753 /* Create or update or destroy in-band. */
756 in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
758 in_band_set_queue(mgr->in_band, mgr->in_band_queue);
760 /* in_band_run() needs a chance to delete any existing in-band flows.
761 * We will destroy mgr->in_band after it's done with that. */
764 in_band_set_remotes(mgr->in_band, addrs, n_addrs);
772 update_fail_open(struct connmgr *mgr)
774 if (connmgr_has_controllers(mgr)
775 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
776 if (!mgr->fail_open) {
777 mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
780 fail_open_destroy(mgr->fail_open);
781 mgr->fail_open = NULL;
786 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
787 const struct sset *sset)
789 struct pvconn **pvconns = *pvconnsp;
790 size_t n_pvconns = *n_pvconnsp;
795 for (i = 0; i < n_pvconns; i++) {
796 pvconn_close(pvconns[i]);
800 pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
802 SSET_FOR_EACH (name, sset) {
803 struct pvconn *pvconn;
805 error = pvconn_open(name, 0, 0, &pvconn);
807 pvconns[n_pvconns++] = pvconn;
809 VLOG_ERR("failed to listen on %s: %s", name, ovs_strerror(error));
817 *n_pvconnsp = n_pvconns;
822 /* Returns a "preference level" for snooping 'ofconn'. A higher return value
823 * means that 'ofconn' is more interesting for monitoring than a lower return
826 snoop_preference(const struct ofconn *ofconn)
828 switch (ofconn->role) {
829 case OFPCR12_ROLE_MASTER:
831 case OFPCR12_ROLE_EQUAL:
833 case OFPCR12_ROLE_SLAVE:
835 case OFPCR12_ROLE_NOCHANGE:
837 /* Shouldn't happen. */
842 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
843 * Connects this vconn to a controller. */
845 add_snooper(struct connmgr *mgr, struct vconn *vconn)
847 struct ofconn *ofconn, *best;
849 /* Pick a controller for monitoring. */
851 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
852 if (ofconn->type == OFCONN_PRIMARY
853 && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
859 rconn_add_monitor(best->rconn, vconn);
861 VLOG_INFO_RL(&rl, "no controller connection to snoop");
866 /* Public ofconn functions. */
868 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
870 ofconn_get_type(const struct ofconn *ofconn)
875 /* If a master election id is defined, stores it into '*idp' and returns
876 * true. Otherwise, stores UINT64_MAX into '*idp' and returns false. */
878 ofconn_get_master_election_id(const struct ofconn *ofconn, uint64_t *idp)
880 *idp = (ofconn->connmgr->master_election_id_defined
881 ? ofconn->connmgr->master_election_id
883 return ofconn->connmgr->master_election_id_defined;
886 /* Sets the master election id.
888 * Returns true if successful, false if the id is stale
891 ofconn_set_master_election_id(struct ofconn *ofconn, uint64_t id)
893 if (ofconn->connmgr->master_election_id_defined
895 /* Unsigned difference interpreted as a two's complement signed
897 (int64_t)(id - ofconn->connmgr->master_election_id) < 0) {
900 ofconn->connmgr->master_election_id = id;
901 ofconn->connmgr->master_election_id_defined = true;
906 /* Returns the role configured for 'ofconn'.
908 * The default role, if no other role has been set, is OFPCR12_ROLE_EQUAL. */
909 enum ofp12_controller_role
910 ofconn_get_role(const struct ofconn *ofconn)
915 /* Changes 'ofconn''s role to 'role'. If 'role' is OFPCR12_ROLE_MASTER then
916 * any existing master is demoted to a slave. */
918 ofconn_set_role(struct ofconn *ofconn, enum ofp12_controller_role role)
920 if (role == OFPCR12_ROLE_MASTER) {
921 struct ofconn *other;
923 HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
924 if (other->role == OFPCR12_ROLE_MASTER) {
925 other->role = OFPCR12_ROLE_SLAVE;
933 ofconn_set_invalid_ttl_to_controller(struct ofconn *ofconn, bool enable)
935 uint32_t bit = 1u << OFPR_INVALID_TTL;
937 ofconn->master_async_config[OAM_PACKET_IN] |= bit;
939 ofconn->master_async_config[OAM_PACKET_IN] &= ~bit;
944 ofconn_get_invalid_ttl_to_controller(struct ofconn *ofconn)
946 uint32_t bit = 1u << OFPR_INVALID_TTL;
947 return (ofconn->master_async_config[OAM_PACKET_IN] & bit) != 0;
950 /* Returns the currently configured protocol for 'ofconn', one of OFPUTIL_P_*.
952 * Returns OFPUTIL_P_NONE, which is not a valid protocol, if 'ofconn' hasn't
953 * completed version negotiation. This can't happen if at least one OpenFlow
954 * message, other than OFPT_HELLO, has been received on the connection (such as
955 * in ofproto.c's message handling code), since version negotiation is a
956 * prerequisite for starting to receive messages. This means that
957 * OFPUTIL_P_NONE is a special case that most callers need not worry about. */
958 enum ofputil_protocol
959 ofconn_get_protocol(const struct ofconn *ofconn)
961 if (ofconn->protocol == OFPUTIL_P_NONE &&
962 rconn_is_connected(ofconn->rconn)) {
963 int version = rconn_get_version(ofconn->rconn);
965 ofconn_set_protocol(CONST_CAST(struct ofconn *, ofconn),
966 ofputil_protocol_from_ofp_version(version));
970 return ofconn->protocol;
973 /* Sets the protocol for 'ofconn' to 'protocol' (one of OFPUTIL_P_*).
975 * (This doesn't actually send anything to accomplish this. Presumably the
976 * caller already did that.) */
978 ofconn_set_protocol(struct ofconn *ofconn, enum ofputil_protocol protocol)
980 ofconn->protocol = protocol;
983 /* Returns the currently configured packet in format for 'ofconn', one of
986 * The default, if no other format has been set, is NXPIF_OPENFLOW10. */
987 enum nx_packet_in_format
988 ofconn_get_packet_in_format(struct ofconn *ofconn)
990 return ofconn->packet_in_format;
993 /* Sets the packet in format for 'ofconn' to 'packet_in_format' (one of
996 ofconn_set_packet_in_format(struct ofconn *ofconn,
997 enum nx_packet_in_format packet_in_format)
999 ofconn->packet_in_format = packet_in_format;
1002 /* Sets the controller connection ID for 'ofconn' to 'controller_id'.
1004 * The connection controller ID is used for OFPP_CONTROLLER and
1005 * NXAST_CONTROLLER actions. See "struct nx_action_controller" for details. */
1007 ofconn_set_controller_id(struct ofconn *ofconn, uint16_t controller_id)
1009 ofconn->controller_id = controller_id;
1012 /* Returns the default miss send length for 'ofconn'. */
1014 ofconn_get_miss_send_len(const struct ofconn *ofconn)
1016 return ofconn->miss_send_len;
1019 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
1021 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
1023 ofconn->miss_send_len = miss_send_len;
1027 ofconn_set_async_config(struct ofconn *ofconn,
1028 const uint32_t master_masks[OAM_N_TYPES],
1029 const uint32_t slave_masks[OAM_N_TYPES])
1031 size_t size = sizeof ofconn->master_async_config;
1032 memcpy(ofconn->master_async_config, master_masks, size);
1033 memcpy(ofconn->slave_async_config, slave_masks, size);
1037 ofconn_get_async_config(struct ofconn *ofconn,
1038 uint32_t *master_masks, uint32_t *slave_masks)
1040 size_t size = sizeof ofconn->master_async_config;
1041 memcpy(master_masks, ofconn->master_async_config, size);
1042 memcpy(slave_masks, ofconn->slave_async_config, size);
1045 /* Sends 'msg' on 'ofconn', accounting it as a reply. (If there is a
1046 * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
1047 * connmgr will stop accepting new OpenFlow requests on that ofconn until the
1048 * controller has accepted some of the replies.) */
1050 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
1052 ofconn_send(ofconn, msg, ofconn->reply_counter);
1055 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
1056 * accounting them as replies. */
1058 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
1060 struct ofpbuf *reply, *next;
1062 LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
1063 list_remove(&reply->list_node);
1064 ofconn_send_reply(ofconn, reply);
1068 /* Sends 'error' on 'ofconn', as a reply to 'request'. Only at most the
1069 * first 64 bytes of 'request' are used. */
1071 ofconn_send_error(const struct ofconn *ofconn,
1072 const struct ofp_header *request, enum ofperr error)
1074 static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1075 struct ofpbuf *reply;
1077 reply = ofperr_encode_reply(error, request);
1078 if (!VLOG_DROP_INFO(&err_rl)) {
1079 const char *type_name;
1083 request_len = ntohs(request->length);
1084 type_name = (!ofpraw_decode_partial(&raw, request,
1085 MIN(64, request_len))
1086 ? ofpraw_get_name(raw)
1089 VLOG_INFO("%s: sending %s error reply to %s message",
1090 rconn_get_name(ofconn->rconn), ofperr_to_string(error),
1093 ofconn_send_reply(ofconn, reply);
1096 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
1098 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
1099 struct ofpbuf **bufferp, ofp_port_t *in_port)
1101 return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
1104 /* Returns true if 'ofconn' has any pending opgroups. */
1106 ofconn_has_pending_opgroups(const struct ofconn *ofconn)
1108 return !list_is_empty(&ofconn->opgroups);
1111 /* Adds 'ofconn_node' to 'ofconn''s list of pending opgroups.
1113 * If 'ofconn' is destroyed or its connection drops, then 'ofconn' will remove
1114 * 'ofconn_node' from the list and re-initialize it with list_init(). The
1115 * client may, therefore, use list_is_empty(ofconn_node) to determine whether
1116 * 'ofconn_node' is still associated with an active ofconn.
1118 * The client may also remove ofconn_node from the list itself, with
1121 ofconn_add_opgroup(struct ofconn *ofconn, struct list *ofconn_node)
1123 list_push_back(&ofconn->opgroups, ofconn_node);
1126 /* Private ofconn functions. */
1129 ofconn_get_target(const struct ofconn *ofconn)
1131 return rconn_get_target(ofconn->rconn);
1134 static struct ofconn *
1135 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type,
1136 bool enable_async_msgs)
1138 struct ofconn *ofconn;
1140 ofconn = xzalloc(sizeof *ofconn);
1141 ofconn->connmgr = mgr;
1142 list_push_back(&mgr->all_conns, &ofconn->node);
1143 ofconn->rconn = rconn;
1144 ofconn->type = type;
1145 ofconn->enable_async_msgs = enable_async_msgs;
1147 list_init(&ofconn->opgroups);
1149 hmap_init(&ofconn->monitors);
1150 list_init(&ofconn->updates);
1152 ofconn_flush(ofconn);
1157 /* Clears all of the state in 'ofconn' that should not persist from one
1158 * connection to the next. */
1160 ofconn_flush(struct ofconn *ofconn)
1161 OVS_REQUIRES(ofproto_mutex)
1163 struct ofmonitor *monitor, *next_monitor;
1166 ofconn->role = OFPCR12_ROLE_EQUAL;
1167 ofconn_set_protocol(ofconn, OFPUTIL_P_NONE);
1168 ofconn->packet_in_format = NXPIF_OPENFLOW10;
1170 /* Disassociate 'ofconn' from all of the ofopgroups that it initiated that
1171 * have not yet completed. (Those ofopgroups will still run to completion
1172 * in the usual way, but any errors that they run into will not be reported
1173 * on any OpenFlow channel.)
1175 * Also discard any blocked operation on 'ofconn'. */
1176 while (!list_is_empty(&ofconn->opgroups)) {
1177 list_init(list_pop_front(&ofconn->opgroups));
1179 ofpbuf_delete(ofconn->blocked);
1180 ofconn->blocked = NULL;
1182 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1183 ofconn->packet_in_counter = rconn_packet_counter_create();
1184 for (i = 0; i < N_SCHEDULERS; i++) {
1185 if (ofconn->schedulers[i]) {
1188 pinsched_get_limits(ofconn->schedulers[i], &rate, &burst);
1189 pinsched_destroy(ofconn->schedulers[i]);
1190 ofconn->schedulers[i] = pinsched_create(rate, burst);
1193 if (ofconn->pktbuf) {
1194 pktbuf_destroy(ofconn->pktbuf);
1195 ofconn->pktbuf = pktbuf_create();
1197 ofconn->miss_send_len = (ofconn->type == OFCONN_PRIMARY
1198 ? OFP_DEFAULT_MISS_SEND_LEN
1200 ofconn->controller_id = 0;
1202 rconn_packet_counter_destroy(ofconn->reply_counter);
1203 ofconn->reply_counter = rconn_packet_counter_create();
1205 if (ofconn->enable_async_msgs) {
1206 uint32_t *master = ofconn->master_async_config;
1207 uint32_t *slave = ofconn->slave_async_config;
1209 /* "master" and "other" roles get all asynchronous messages by default,
1210 * except that the controller needs to enable nonstandard "packet-in"
1211 * reasons itself. */
1212 master[OAM_PACKET_IN] = (1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION);
1213 master[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1214 | (1u << OFPPR_DELETE)
1215 | (1u << OFPPR_MODIFY));
1216 master[OAM_FLOW_REMOVED] = ((1u << OFPRR_IDLE_TIMEOUT)
1217 | (1u << OFPRR_HARD_TIMEOUT)
1218 | (1u << OFPRR_DELETE));
1220 /* "slave" role gets port status updates by default. */
1221 slave[OAM_PACKET_IN] = 0;
1222 slave[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1223 | (1u << OFPPR_DELETE)
1224 | (1u << OFPPR_MODIFY));
1225 slave[OAM_FLOW_REMOVED] = 0;
1227 memset(ofconn->master_async_config, 0,
1228 sizeof ofconn->master_async_config);
1229 memset(ofconn->slave_async_config, 0,
1230 sizeof ofconn->slave_async_config);
1233 HMAP_FOR_EACH_SAFE (monitor, next_monitor, ofconn_node,
1234 &ofconn->monitors) {
1235 ofmonitor_destroy(monitor);
1237 rconn_packet_counter_destroy(ofconn->monitor_counter);
1238 ofconn->monitor_counter = rconn_packet_counter_create();
1239 ofpbuf_list_delete(&ofconn->updates); /* ...but it should be empty. */
1243 ofconn_destroy(struct ofconn *ofconn)
1244 OVS_REQUIRES(ofproto_mutex)
1246 ofconn_flush(ofconn);
1248 if (ofconn->type == OFCONN_PRIMARY) {
1249 hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
1252 hmap_destroy(&ofconn->monitors);
1253 list_remove(&ofconn->node);
1254 rconn_destroy(ofconn->rconn);
1255 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1256 rconn_packet_counter_destroy(ofconn->reply_counter);
1257 pktbuf_destroy(ofconn->pktbuf);
1258 rconn_packet_counter_destroy(ofconn->monitor_counter);
1262 /* Reconfigures 'ofconn' to match 'c'. 'ofconn' and 'c' must have the same
1265 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
1269 ofconn->band = c->band;
1270 ofconn->enable_async_msgs = c->enable_async_msgs;
1272 rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
1274 probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
1275 rconn_set_probe_interval(ofconn->rconn, probe_interval);
1277 ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
1279 /* If dscp value changed reconnect. */
1280 if (c->dscp != rconn_get_dscp(ofconn->rconn)) {
1281 rconn_set_dscp(ofconn->rconn, c->dscp);
1282 rconn_reconnect(ofconn->rconn);
1286 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
1289 ofconn_may_recv(const struct ofconn *ofconn)
1291 int count = rconn_packet_counter_n_packets(ofconn->reply_counter);
1292 return (!ofconn->blocked || ofconn->retry) && count < OFCONN_REPLY_MAX;
1296 ofconn_run(struct ofconn *ofconn,
1297 bool (*handle_openflow)(struct ofconn *,
1298 const struct ofpbuf *ofp_msg))
1300 struct connmgr *mgr = ofconn->connmgr;
1303 for (i = 0; i < N_SCHEDULERS; i++) {
1306 pinsched_run(ofconn->schedulers[i], &txq);
1307 do_send_packet_ins(ofconn, &txq);
1310 rconn_run(ofconn->rconn);
1312 if (handle_openflow) {
1313 /* Limit the number of iterations to avoid starving other tasks. */
1314 for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
1315 struct ofpbuf *of_msg;
1317 of_msg = (ofconn->blocked
1319 : rconn_recv(ofconn->rconn));
1323 if (mgr->fail_open) {
1324 fail_open_maybe_recover(mgr->fail_open);
1327 if (handle_openflow(ofconn, of_msg)) {
1328 ofpbuf_delete(of_msg);
1329 ofconn->blocked = NULL;
1331 ofconn->blocked = of_msg;
1332 ofconn->retry = false;
1337 ovs_mutex_lock(&ofproto_mutex);
1338 if (!rconn_is_alive(ofconn->rconn)) {
1339 ofconn_destroy(ofconn);
1340 } else if (!rconn_is_connected(ofconn->rconn)) {
1341 ofconn_flush(ofconn);
1343 ovs_mutex_unlock(&ofproto_mutex);
1347 ofconn_wait(struct ofconn *ofconn, bool handling_openflow)
1351 for (i = 0; i < N_SCHEDULERS; i++) {
1352 pinsched_wait(ofconn->schedulers[i]);
1354 rconn_run_wait(ofconn->rconn);
1355 if (handling_openflow && ofconn_may_recv(ofconn)) {
1356 rconn_recv_wait(ofconn->rconn);
1360 /* Returns true if 'ofconn' should receive asynchronous messages of the given
1361 * OAM_* 'type' and 'reason', which should be a OFPR_* value for OAM_PACKET_IN,
1362 * a OFPPR_* value for OAM_PORT_STATUS, or an OFPRR_* value for
1363 * OAM_FLOW_REMOVED. Returns false if the message should not be sent on
1366 ofconn_receives_async_msg(const struct ofconn *ofconn,
1367 enum ofconn_async_msg_type type,
1368 unsigned int reason)
1370 const uint32_t *async_config;
1372 ovs_assert(reason < 32);
1373 ovs_assert((unsigned int) type < OAM_N_TYPES);
1375 if (ofconn_get_protocol(ofconn) == OFPUTIL_P_NONE
1376 || !rconn_is_connected(ofconn->rconn)) {
1380 /* Keep the following code in sync with the documentation in the
1381 * "Asynchronous Messages" section in DESIGN. */
1383 if (ofconn->type == OFCONN_SERVICE && !ofconn->miss_send_len) {
1384 /* Service connections don't get asynchronous messages unless they have
1385 * explicitly asked for them by setting a nonzero miss send length. */
1389 async_config = (ofconn->role == OFPCR12_ROLE_SLAVE
1390 ? ofconn->slave_async_config
1391 : ofconn->master_async_config);
1392 if (!(async_config[type] & (1u << reason))) {
1399 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1400 * 'target', suitable for use in log messages for identifying the connection.
1402 * The name is dynamically allocated. The caller should free it (with free())
1403 * when it is no longer needed. */
1405 ofconn_make_name(const struct connmgr *mgr, const char *target)
1407 return xasprintf("%s<->%s", mgr->name, target);
1411 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1415 for (i = 0; i < N_SCHEDULERS; i++) {
1416 struct pinsched **s = &ofconn->schedulers[i];
1420 *s = pinsched_create(rate, burst);
1422 pinsched_set_limits(*s, rate, burst);
1425 pinsched_destroy(*s);
1432 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1433 struct rconn_packet_counter *counter)
1435 ofpmsg_update_length(msg);
1436 rconn_send(ofconn->rconn, msg, counter);
1439 /* Sending asynchronous messages. */
1441 static void schedule_packet_in(struct ofconn *, struct ofproto_packet_in,
1442 enum ofp_packet_in_reason wire_reason);
1444 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1445 * controllers managed by 'mgr'. */
1447 connmgr_send_port_status(struct connmgr *mgr,
1448 const struct ofputil_phy_port *pp, uint8_t reason)
1450 /* XXX Should limit the number of queued port status change messages. */
1451 struct ofputil_port_status ps;
1452 struct ofconn *ofconn;
1456 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1457 if (ofconn_receives_async_msg(ofconn, OAM_PORT_STATUS, reason)) {
1460 msg = ofputil_encode_port_status(&ps, ofconn_get_protocol(ofconn));
1461 ofconn_send(ofconn, msg, NULL);
1466 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1467 * appropriate controllers managed by 'mgr'. */
1469 connmgr_send_flow_removed(struct connmgr *mgr,
1470 const struct ofputil_flow_removed *fr)
1472 struct ofconn *ofconn;
1474 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1475 if (ofconn_receives_async_msg(ofconn, OAM_FLOW_REMOVED, fr->reason)) {
1478 /* Account flow expirations as replies to OpenFlow requests. That
1479 * works because preventing OpenFlow requests from being processed
1480 * also prevents new flows from being added (and expiring). (It
1481 * also prevents processing OpenFlow requests that would not add
1482 * new flows, so it is imperfect.) */
1483 msg = ofputil_encode_flow_removed(fr, ofconn_get_protocol(ofconn));
1484 ofconn_send_reply(ofconn, msg);
1489 /* Normally a send-to-controller action uses reason OFPR_ACTION. However, in
1490 * OpenFlow 1.3 and later, packet_ins generated by a send-to-controller action
1491 * in a "table-miss" flow (one with priority 0 and completely wildcarded) are
1492 * sent as OFPR_NO_MATCH. This function returns the reason that should
1493 * actually be sent on 'ofconn' for 'pin'. */
1494 static enum ofp_packet_in_reason
1495 wire_reason(struct ofconn *ofconn, const struct ofproto_packet_in *pin)
1497 if (pin->generated_by_table_miss && pin->up.reason == OFPR_ACTION) {
1498 enum ofputil_protocol protocol = ofconn_get_protocol(ofconn);
1499 enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
1501 if (version >= OFP13_VERSION) {
1502 return OFPR_NO_MATCH;
1505 return pin->up.reason;
1508 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1509 * necessary according to their individual configurations.
1511 * The caller doesn't need to fill in pin->buffer_id or pin->total_len. */
1513 connmgr_send_packet_in(struct connmgr *mgr,
1514 const struct ofproto_packet_in *pin)
1516 struct ofconn *ofconn;
1518 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1519 enum ofp_packet_in_reason reason = wire_reason(ofconn, pin);
1521 if (ofconn_receives_async_msg(ofconn, OAM_PACKET_IN, reason)
1522 && ofconn->controller_id == pin->controller_id) {
1523 schedule_packet_in(ofconn, *pin, reason);
1529 do_send_packet_ins(struct ofconn *ofconn, struct list *txq)
1531 struct ofpbuf *pin, *next_pin;
1533 LIST_FOR_EACH_SAFE (pin, next_pin, list_node, txq) {
1534 list_remove(&pin->list_node);
1536 rconn_send_with_limit(ofconn->rconn, pin,
1537 ofconn->packet_in_counter, 100);
1541 /* Takes 'pin', composes an OpenFlow packet-in message from it, and passes it
1542 * to 'ofconn''s packet scheduler for sending. */
1544 schedule_packet_in(struct ofconn *ofconn, struct ofproto_packet_in pin,
1545 enum ofp_packet_in_reason wire_reason)
1547 struct connmgr *mgr = ofconn->connmgr;
1548 uint16_t controller_max_len;
1551 pin.up.total_len = pin.up.packet_len;
1553 pin.up.reason = wire_reason;
1554 if (pin.up.reason == OFPR_ACTION) {
1555 controller_max_len = pin.send_len; /* max_len */
1557 controller_max_len = ofconn->miss_send_len;
1560 /* Get OpenFlow buffer_id.
1561 * For OpenFlow 1.2+, OFPCML_NO_BUFFER (== UINT16_MAX) specifies
1562 * unbuffered. This behaviour doesn't violate prior versions, too. */
1563 if (controller_max_len == UINT16_MAX) {
1564 pin.up.buffer_id = UINT32_MAX;
1565 } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1566 pin.up.buffer_id = pktbuf_get_null();
1567 } else if (!ofconn->pktbuf) {
1568 pin.up.buffer_id = UINT32_MAX;
1570 pin.up.buffer_id = pktbuf_save(ofconn->pktbuf,
1571 pin.up.packet, pin.up.packet_len,
1572 pin.up.fmd.in_port);
1575 /* Figure out how much of the packet to send.
1576 * If not buffered, send the entire packet. Otherwise, depending on
1577 * the reason of packet-in, send what requested by the controller. */
1578 if (pin.up.buffer_id != UINT32_MAX
1579 && controller_max_len < pin.up.packet_len) {
1580 pin.up.packet_len = controller_max_len;
1583 /* Make OFPT_PACKET_IN and hand over to packet scheduler. */
1584 pinsched_send(ofconn->schedulers[pin.up.reason == OFPR_NO_MATCH ? 0 : 1],
1586 ofputil_encode_packet_in(&pin.up,
1587 ofconn_get_protocol(ofconn),
1588 ofconn->packet_in_format),
1590 do_send_packet_ins(ofconn, &txq);
1593 /* Fail-open settings. */
1595 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1596 * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1597 enum ofproto_fail_mode
1598 connmgr_get_fail_mode(const struct connmgr *mgr)
1600 return mgr->fail_mode;
1603 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1604 * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1606 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1608 if (mgr->fail_mode != fail_mode) {
1609 mgr->fail_mode = fail_mode;
1610 update_fail_open(mgr);
1611 if (!connmgr_has_controllers(mgr)) {
1612 ofproto_flush_flows(mgr->ofproto);
1617 /* Fail-open implementation. */
1619 /* Returns the longest probe interval among the primary controllers configured
1620 * on 'mgr'. Returns 0 if there are no primary controllers. */
1622 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1624 const struct ofconn *ofconn;
1625 int max_probe_interval;
1627 max_probe_interval = 0;
1628 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1629 int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1630 max_probe_interval = MAX(max_probe_interval, probe_interval);
1632 return max_probe_interval;
1635 /* Returns the number of seconds for which all of 'mgr's primary controllers
1636 * have been disconnected. Returns 0 if 'mgr' has no primary controllers. */
1638 connmgr_failure_duration(const struct connmgr *mgr)
1640 const struct ofconn *ofconn;
1641 int min_failure_duration;
1643 if (!connmgr_has_controllers(mgr)) {
1647 min_failure_duration = INT_MAX;
1648 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1649 int failure_duration = rconn_failure_duration(ofconn->rconn);
1650 min_failure_duration = MIN(min_failure_duration, failure_duration);
1652 return min_failure_duration;
1655 /* Returns true if at least one primary controller is connected (regardless of
1656 * whether those controllers are believed to have authenticated and accepted
1657 * this switch), false if none of them are connected. */
1659 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1661 const struct ofconn *ofconn;
1663 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1664 if (rconn_is_connected(ofconn->rconn)) {
1671 /* Returns true if at least one primary controller is believed to have
1672 * authenticated and accepted this switch, false otherwise. */
1674 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1676 const struct ofconn *ofconn;
1678 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1679 if (rconn_is_admitted(ofconn->rconn)) {
1686 /* In-band configuration. */
1688 static bool any_extras_changed(const struct connmgr *,
1689 const struct sockaddr_in *extras, size_t n);
1691 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1692 * in-band control should guarantee access, in the same way that in-band
1693 * control guarantees access to OpenFlow controllers. */
1695 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1696 const struct sockaddr_in *extras, size_t n)
1698 if (!any_extras_changed(mgr, extras, n)) {
1702 free(mgr->extra_in_band_remotes);
1703 mgr->n_extra_remotes = n;
1704 mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1706 update_in_band_remotes(mgr);
1709 /* Sets the OpenFlow queue used by flows set up by in-band control on
1710 * 'mgr' to 'queue_id'. If 'queue_id' is negative, then in-band control
1711 * flows will use the default queue. */
1713 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1715 if (queue_id != mgr->in_band_queue) {
1716 mgr->in_band_queue = queue_id;
1717 update_in_band_remotes(mgr);
1722 any_extras_changed(const struct connmgr *mgr,
1723 const struct sockaddr_in *extras, size_t n)
1727 if (n != mgr->n_extra_remotes) {
1731 for (i = 0; i < n; i++) {
1732 const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1733 const struct sockaddr_in *new = &extras[i];
1735 if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1736 old->sin_port != new->sin_port) {
1744 /* In-band implementation. */
1747 connmgr_has_in_band(struct connmgr *mgr)
1749 return mgr->in_band != NULL;
1752 /* Fail-open and in-band implementation. */
1754 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1755 * and standalone mode to re-create their flows.
1757 * In-band control has more sophisticated code that manages flows itself. */
1759 connmgr_flushed(struct connmgr *mgr)
1760 OVS_EXCLUDED(ofproto_mutex)
1762 if (mgr->fail_open) {
1763 fail_open_flushed(mgr->fail_open);
1766 /* If there are no controllers and we're in standalone mode, set up a flow
1767 * that matches every packet and directs them to OFPP_NORMAL (which goes to
1768 * us). Otherwise, the switch is in secure mode and we won't pass any
1769 * traffic until a controller has been defined and it tells us to do so. */
1770 if (!connmgr_has_controllers(mgr)
1771 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1772 struct ofpbuf ofpacts;
1775 ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
1776 ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
1777 ofpact_pad(&ofpacts);
1779 match_init_catchall(&match);
1780 ofproto_add_flow(mgr->ofproto, &match, 0, ofpacts.data, ofpacts.size);
1782 ofpbuf_uninit(&ofpacts);
1786 /* Creates a new ofservice for 'target' in 'mgr'. Returns 0 if successful,
1787 * otherwise a positive errno value.
1789 * ofservice_reconfigure() must be called to fully configure the new
1792 ofservice_create(struct connmgr *mgr, const char *target,
1793 uint32_t allowed_versions, uint8_t dscp)
1795 struct ofservice *ofservice;
1796 struct pvconn *pvconn;
1799 error = pvconn_open(target, allowed_versions, dscp, &pvconn);
1804 ofservice = xzalloc(sizeof *ofservice);
1805 hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1806 ofservice->pvconn = pvconn;
1807 ofservice->allowed_versions = allowed_versions;
1813 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1815 hmap_remove(&mgr->services, &ofservice->node);
1816 pvconn_close(ofservice->pvconn);
1821 ofservice_reconfigure(struct ofservice *ofservice,
1822 const struct ofproto_controller *c)
1824 ofservice->probe_interval = c->probe_interval;
1825 ofservice->rate_limit = c->rate_limit;
1826 ofservice->burst_limit = c->burst_limit;
1827 ofservice->enable_async_msgs = c->enable_async_msgs;
1828 ofservice->dscp = c->dscp;
1831 /* Finds and returns the ofservice within 'mgr' that has the given
1832 * 'target', or a null pointer if none exists. */
1833 static struct ofservice *
1834 ofservice_lookup(struct connmgr *mgr, const char *target)
1836 struct ofservice *ofservice;
1838 HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1840 if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1847 /* Flow monitors (NXST_FLOW_MONITOR). */
1849 /* A counter incremented when something significant happens to an OpenFlow
1852 * - When a rule is added, its 'add_seqno' and 'modify_seqno' are set to
1853 * the current value (which is then incremented).
1855 * - When a rule is modified, its 'modify_seqno' is set to the current
1856 * value (which is then incremented).
1858 * Thus, by comparing an old value of monitor_seqno against a rule's
1859 * 'add_seqno', one can tell whether the rule was added before or after the old
1860 * value was read, and similarly for 'modify_seqno'.
1862 * 32 bits should normally be sufficient (and would be nice, to save space in
1863 * each rule) but then we'd have to have some special cases for wraparound.
1865 * We initialize monitor_seqno to 1 to allow 0 to be used as an invalid
1867 static uint64_t monitor_seqno = 1;
1869 COVERAGE_DEFINE(ofmonitor_pause);
1870 COVERAGE_DEFINE(ofmonitor_resume);
1873 ofmonitor_create(const struct ofputil_flow_monitor_request *request,
1874 struct ofconn *ofconn, struct ofmonitor **monitorp)
1875 OVS_REQUIRES(ofproto_mutex)
1877 struct ofmonitor *m;
1881 m = ofmonitor_lookup(ofconn, request->id);
1883 return OFPERR_NXBRC_FM_DUPLICATE_ID;
1886 m = xmalloc(sizeof *m);
1888 hmap_insert(&ofconn->monitors, &m->ofconn_node, hash_int(request->id, 0));
1889 m->id = request->id;
1890 m->flags = request->flags;
1891 m->out_port = request->out_port;
1892 m->table_id = request->table_id;
1893 minimatch_init(&m->match, &request->match);
1900 ofmonitor_lookup(struct ofconn *ofconn, uint32_t id)
1901 OVS_REQUIRES(ofproto_mutex)
1903 struct ofmonitor *m;
1905 HMAP_FOR_EACH_IN_BUCKET (m, ofconn_node, hash_int(id, 0),
1906 &ofconn->monitors) {
1915 ofmonitor_destroy(struct ofmonitor *m)
1916 OVS_REQUIRES(ofproto_mutex)
1919 minimatch_destroy(&m->match);
1920 hmap_remove(&m->ofconn->monitors, &m->ofconn_node);
1926 ofmonitor_report(struct connmgr *mgr, struct rule *rule,
1927 enum nx_flow_update_event event,
1928 enum ofp_flow_removed_reason reason,
1929 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
1930 OVS_REQUIRES(ofproto_mutex)
1932 enum nx_flow_monitor_flags update;
1933 struct ofconn *ofconn;
1938 rule->add_seqno = rule->modify_seqno = monitor_seqno++;
1942 update = NXFMF_DELETE;
1945 case NXFME_MODIFIED:
1946 update = NXFMF_MODIFY;
1947 rule->modify_seqno = monitor_seqno++;
1955 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1956 enum nx_flow_monitor_flags flags = 0;
1957 struct ofmonitor *m;
1959 if (ofconn->monitor_paused) {
1960 /* Only send NXFME_DELETED notifications for flows that were added
1961 * before we paused. */
1962 if (event != NXFME_DELETED
1963 || rule->add_seqno > ofconn->monitor_paused) {
1968 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1969 if (m->flags & update
1970 && (m->table_id == 0xff || m->table_id == rule->table_id)
1971 && ofoperation_has_out_port(rule->pending, m->out_port)
1972 && cls_rule_is_loose_match(&rule->cr, &m->match)) {
1978 if (list_is_empty(&ofconn->updates)) {
1979 ofputil_start_flow_update(&ofconn->updates);
1980 ofconn->sent_abbrev_update = false;
1983 if (ofconn != abbrev_ofconn || ofconn->monitor_paused) {
1984 struct ofputil_flow_update fu;
1988 fu.reason = event == NXFME_DELETED ? reason : 0;
1989 fu.table_id = rule->table_id;
1990 fu.cookie = rule->flow_cookie;
1991 minimatch_expand(&rule->cr.match, &match);
1993 fu.priority = rule->cr.priority;
1995 ovs_mutex_lock(&rule->mutex);
1996 fu.idle_timeout = rule->idle_timeout;
1997 fu.hard_timeout = rule->hard_timeout;
1998 ovs_mutex_unlock(&rule->mutex);
2000 if (flags & NXFMF_ACTIONS) {
2001 fu.ofpacts = rule->actions->ofpacts;
2002 fu.ofpacts_len = rule->actions->ofpacts_len;
2007 ofputil_append_flow_update(&fu, &ofconn->updates);
2008 } else if (!ofconn->sent_abbrev_update) {
2009 struct ofputil_flow_update fu;
2011 fu.event = NXFME_ABBREV;
2012 fu.xid = abbrev_xid;
2013 ofputil_append_flow_update(&fu, &ofconn->updates);
2015 ofconn->sent_abbrev_update = true;
2022 ofmonitor_flush(struct connmgr *mgr)
2023 OVS_REQUIRES(ofproto_mutex)
2025 struct ofconn *ofconn;
2027 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2028 struct ofpbuf *msg, *next;
2030 LIST_FOR_EACH_SAFE (msg, next, list_node, &ofconn->updates) {
2031 unsigned int n_bytes;
2033 list_remove(&msg->list_node);
2034 ofconn_send(ofconn, msg, ofconn->monitor_counter);
2035 n_bytes = rconn_packet_counter_n_bytes(ofconn->monitor_counter);
2036 if (!ofconn->monitor_paused && n_bytes > 128 * 1024) {
2037 struct ofpbuf *pause;
2039 COVERAGE_INC(ofmonitor_pause);
2040 ofconn->monitor_paused = monitor_seqno++;
2041 pause = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_PAUSED,
2042 OFP10_VERSION, htonl(0), 0);
2043 ofconn_send(ofconn, pause, ofconn->monitor_counter);
2050 ofmonitor_resume(struct ofconn *ofconn)
2051 OVS_REQUIRES(ofproto_mutex)
2053 struct rule_collection rules;
2054 struct ofpbuf *resumed;
2055 struct ofmonitor *m;
2058 rule_collection_init(&rules);
2059 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
2060 ofmonitor_collect_resume_rules(m, ofconn->monitor_paused, &rules);
2064 ofmonitor_compose_refresh_updates(&rules, &msgs);
2066 resumed = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
2068 list_push_back(&msgs, &resumed->list_node);
2069 ofconn_send_replies(ofconn, &msgs);
2071 ofconn->monitor_paused = 0;
2075 ofmonitor_may_resume(const struct ofconn *ofconn)
2076 OVS_REQUIRES(ofproto_mutex)
2078 return (ofconn->monitor_paused != 0
2079 && !rconn_packet_counter_n_packets(ofconn->monitor_counter));
2083 ofmonitor_run(struct connmgr *mgr)
2085 struct ofconn *ofconn;
2087 ovs_mutex_lock(&ofproto_mutex);
2088 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2089 if (ofmonitor_may_resume(ofconn)) {
2090 COVERAGE_INC(ofmonitor_resume);
2091 ofmonitor_resume(ofconn);
2094 ovs_mutex_unlock(&ofproto_mutex);
2098 ofmonitor_wait(struct connmgr *mgr)
2100 struct ofconn *ofconn;
2102 ovs_mutex_lock(&ofproto_mutex);
2103 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
2104 if (ofmonitor_may_resume(ofconn)) {
2105 poll_immediate_wake();
2108 ovs_mutex_unlock(&ofproto_mutex);