2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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.
20 #include "classifier.h"
24 #include "ofp-errors.h"
27 #include "ofproto-provider.h"
28 #include "openflow/nicira-ext.h"
29 #include "openvswitch/types.h"
37 /* ofproto supports two kinds of OpenFlow connections:
39 * - "Primary" connections to ordinary OpenFlow controllers. ofproto
40 * maintains persistent connections to these controllers and by default
41 * sends them asynchronous messages such as packet-ins.
43 * - "Service" connections, e.g. from ovs-ofctl. When these connections
44 * drop, it is the other side's responsibility to reconnect them if
45 * necessary. ofproto does not send them asynchronous messages by default.
47 * Currently, active (tcp, ssl, unix) connections are always "primary"
48 * connections and passive (ptcp, pssl, punix) connections are always "service"
49 * connections. There is no inherent reason for this, but it reflects the
53 OFCONN_PRIMARY, /* An ordinary OpenFlow controller. */
54 OFCONN_SERVICE /* A service connection, e.g. "ovs-ofctl". */
57 /* An asynchronous message that might need to be queued between threads. */
58 struct ofproto_async_msg {
59 struct ovs_list list_node; /* For queuing. */
60 uint16_t controller_id; /* Controller ID to send to. */
62 enum ofputil_async_msg_type oam;
65 struct ofputil_packet_in_private up;
66 int max_len; /* From action, or -1 if none. */
69 void ofproto_async_msg_free(struct ofproto_async_msg *);
72 struct connmgr *connmgr_create(struct ofproto *ofproto,
73 const char *dpif_name, const char *local_name);
74 void connmgr_destroy(struct connmgr *);
76 void connmgr_run(struct connmgr *,
77 void (*handle_openflow)(struct ofconn *,
78 const struct ofpbuf *ofp_msg));
79 void connmgr_wait(struct connmgr *);
81 void connmgr_get_memory_usage(const struct connmgr *, struct simap *usage);
83 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
85 void connmgr_retry(struct connmgr *);
87 /* OpenFlow configuration. */
88 bool connmgr_has_controllers(const struct connmgr *);
89 void connmgr_get_controller_info(struct connmgr *, struct shash *);
90 void connmgr_free_controller_info(struct shash *);
91 void connmgr_set_controllers(struct connmgr *,
92 const struct ofproto_controller[], size_t n,
93 uint32_t allowed_versions);
94 void connmgr_reconnect(const struct connmgr *);
96 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
97 bool connmgr_has_snoops(const struct connmgr *);
98 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
100 /* Individual connections to OpenFlow controllers. */
101 enum ofconn_type ofconn_get_type(const struct ofconn *);
103 bool ofconn_get_master_election_id(const struct ofconn *, uint64_t *idp);
104 bool ofconn_set_master_election_id(struct ofconn *, uint64_t);
105 enum ofp12_controller_role ofconn_get_role(const struct ofconn *);
106 void ofconn_set_role(struct ofconn *, enum ofp12_controller_role);
108 enum ofputil_protocol ofconn_get_protocol(const struct ofconn *);
109 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
111 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
112 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
114 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
116 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
117 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
119 int ofconn_get_miss_send_len(const struct ofconn *);
120 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
122 void ofconn_set_async_config(struct ofconn *,
123 const struct ofputil_async_cfg *);
124 struct ofputil_async_cfg ofconn_get_async_config(const struct ofconn *);
126 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
127 void ofconn_send_replies(const struct ofconn *, struct ovs_list *);
128 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
131 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
132 struct dp_packet **bufferp, ofp_port_t *in_port);
136 struct ofp_bundle *ofconn_get_bundle(struct ofconn *, uint32_t id);
137 enum ofperr ofconn_insert_bundle(struct ofconn *, struct ofp_bundle *);
138 enum ofperr ofconn_remove_bundle(struct ofconn *, struct ofp_bundle *);
140 /* Logging flow_mod summaries. */
141 void ofconn_report_flow_mod(struct ofconn *, enum ofp_flow_mod_command);
143 /* Sending asynchronous messages. */
144 bool connmgr_wants_packet_in_on_miss(struct connmgr *mgr);
145 void connmgr_send_port_status(struct connmgr *, struct ofconn *source,
146 const struct ofputil_phy_port *, uint8_t reason);
147 void connmgr_send_flow_removed(struct connmgr *,
148 const struct ofputil_flow_removed *);
149 void connmgr_send_async_msg(struct connmgr *,
150 const struct ofproto_async_msg *);
151 void ofconn_send_role_status(struct ofconn *ofconn, uint32_t role,
154 void connmgr_send_requestforward(struct connmgr *, const struct ofconn *source,
155 const struct ofputil_requestforward *);
157 /* Fail-open settings. */
158 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
159 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
161 /* Fail-open implementation. */
162 int connmgr_get_max_probe_interval(const struct connmgr *);
163 bool connmgr_is_any_controller_connected(const struct connmgr *);
164 bool connmgr_is_any_controller_admitted(const struct connmgr *);
165 int connmgr_failure_duration(const struct connmgr *);
167 /* In-band configuration. */
168 void connmgr_set_extra_in_band_remotes(struct connmgr *,
169 const struct sockaddr_in *, size_t);
170 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
172 /* In-band implementation. */
173 bool connmgr_has_in_band(struct connmgr *);
175 /* Fail-open and in-band implementation. */
176 void connmgr_flushed(struct connmgr *);
178 int connmgr_count_hidden_rules(const struct connmgr *);
180 /* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
182 struct ofconn *ofconn; /* Owning 'ofconn'. */
183 struct hmap_node ofconn_node; /* In ofconn's 'monitors' hmap. */
186 enum nx_flow_monitor_flags flags;
191 struct minimatch match;
194 struct ofputil_flow_monitor_request;
196 enum ofperr ofmonitor_create(const struct ofputil_flow_monitor_request *,
197 struct ofconn *, struct ofmonitor **)
198 OVS_REQUIRES(ofproto_mutex);
199 struct ofmonitor *ofmonitor_lookup(struct ofconn *, uint32_t id)
200 OVS_REQUIRES(ofproto_mutex);
201 void ofmonitor_destroy(struct ofmonitor *)
202 OVS_REQUIRES(ofproto_mutex);
204 void ofmonitor_report(struct connmgr *, struct rule *,
205 enum nx_flow_update_event, enum ofp_flow_removed_reason,
206 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid,
207 const struct rule_actions *old_actions)
208 OVS_REQUIRES(ofproto_mutex);
209 void ofmonitor_flush(struct connmgr *) OVS_REQUIRES(ofproto_mutex);
212 struct rule_collection;
213 void ofmonitor_collect_resume_rules(struct ofmonitor *, uint64_t seqno,
214 struct rule_collection *)
215 OVS_REQUIRES(ofproto_mutex);
216 void ofmonitor_compose_refresh_updates(struct rule_collection *rules,
217 struct ovs_list *msgs)
218 OVS_REQUIRES(ofproto_mutex);
220 void connmgr_send_table_status(struct connmgr *,
221 const struct ofputil_table_desc *td,
223 #endif /* connmgr.h */