2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 /* The type of an OpenFlow asynchronous message. */
58 enum ofconn_async_msg_type {
59 OAM_PACKET_IN, /* OFPT_PACKET_IN or NXT_PACKET_IN. */
60 OAM_PORT_STATUS, /* OFPT_PORT_STATUS. */
61 OAM_FLOW_REMOVED, /* OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED. */
65 enum ofproto_packet_in_miss_type {
66 /* Not generated by a flow miss or table-miss flow. */
67 OFPROTO_PACKET_IN_NO_MISS,
69 /* The packet_in was generated directly by a table-miss flow, that is, a
70 * flow with priority 0 that wildcards all fields. See OF1.3.3 section
73 * (Our interpretation of "directly" is "not via groups". Packet_ins
74 * generated by table-miss flows via groups use
75 * OFPROTO_PACKET_IN_NO_MISS.) */
76 OFPROTO_PACKET_IN_MISS_FLOW,
78 /* The packet-in was generated directly by a table-miss, but not a
79 * table-miss flow. That is, it was generated by the OpenFlow 1.0, 1.1, or
80 * 1.2 table-miss behavior. */
81 OFPROTO_PACKET_IN_MISS_WITHOUT_FLOW,
84 /* A packet_in, with extra members to assist in queuing and routing it. */
85 struct ofproto_packet_in {
86 struct ofputil_packet_in up;
87 struct ovs_list list_node; /* For queuing. */
88 uint16_t controller_id; /* Controller ID to send to. */
89 int send_len; /* Length that the action requested sending. */
90 enum ofproto_packet_in_miss_type miss_type;
94 struct connmgr *connmgr_create(struct ofproto *ofproto,
95 const char *dpif_name, const char *local_name);
96 void connmgr_destroy(struct connmgr *);
98 void connmgr_run(struct connmgr *,
99 void (*handle_openflow)(struct ofconn *,
100 const struct ofpbuf *ofp_msg));
101 void connmgr_wait(struct connmgr *);
103 void connmgr_get_memory_usage(const struct connmgr *, struct simap *usage);
105 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
107 void connmgr_retry(struct connmgr *);
109 /* OpenFlow configuration. */
110 bool connmgr_has_controllers(const struct connmgr *);
111 void connmgr_get_controller_info(struct connmgr *, struct shash *);
112 void connmgr_free_controller_info(struct shash *);
113 void connmgr_set_controllers(struct connmgr *,
114 const struct ofproto_controller[], size_t n,
115 uint32_t allowed_versions);
116 void connmgr_reconnect(const struct connmgr *);
118 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
119 bool connmgr_has_snoops(const struct connmgr *);
120 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
122 /* Individual connections to OpenFlow controllers. */
123 enum ofconn_type ofconn_get_type(const struct ofconn *);
125 bool ofconn_get_master_election_id(const struct ofconn *, uint64_t *idp);
126 bool ofconn_set_master_election_id(struct ofconn *, uint64_t);
127 enum ofp12_controller_role ofconn_get_role(const struct ofconn *);
128 void ofconn_set_role(struct ofconn *, enum ofp12_controller_role);
130 enum ofputil_protocol ofconn_get_protocol(const struct ofconn *);
131 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
133 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
134 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
136 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
138 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
139 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
141 int ofconn_get_miss_send_len(const struct ofconn *);
142 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
144 void ofconn_set_async_config(struct ofconn *,
145 const uint32_t master_masks[OAM_N_TYPES],
146 const uint32_t slave_masks[OAM_N_TYPES]);
147 void ofconn_get_async_config(struct ofconn *,
148 uint32_t *master_masks,
149 uint32_t *slave_masks);
151 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
152 void ofconn_send_replies(const struct ofconn *, struct ovs_list *);
153 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
156 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
157 struct dp_packet **bufferp, ofp_port_t *in_port);
161 struct ofp_bundle *ofconn_get_bundle(struct ofconn *, uint32_t id);
162 enum ofperr ofconn_insert_bundle(struct ofconn *, struct ofp_bundle *);
163 enum ofperr ofconn_remove_bundle(struct ofconn *, struct ofp_bundle *);
165 /* Logging flow_mod summaries. */
166 void ofconn_report_flow_mod(struct ofconn *, enum ofp_flow_mod_command);
168 /* Sending asynchronous messages. */
169 bool connmgr_wants_packet_in_on_miss(struct connmgr *mgr);
170 void connmgr_send_port_status(struct connmgr *, struct ofconn *source,
171 const struct ofputil_phy_port *, uint8_t reason);
172 void connmgr_send_flow_removed(struct connmgr *,
173 const struct ofputil_flow_removed *);
174 void connmgr_send_packet_in(struct connmgr *,
175 const struct ofproto_packet_in *);
176 void ofconn_send_role_status(struct ofconn *ofconn, uint32_t role,
179 /* Fail-open settings. */
180 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
181 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
183 /* Fail-open implementation. */
184 int connmgr_get_max_probe_interval(const struct connmgr *);
185 bool connmgr_is_any_controller_connected(const struct connmgr *);
186 bool connmgr_is_any_controller_admitted(const struct connmgr *);
187 int connmgr_failure_duration(const struct connmgr *);
189 /* In-band configuration. */
190 void connmgr_set_extra_in_band_remotes(struct connmgr *,
191 const struct sockaddr_in *, size_t);
192 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
194 /* In-band implementation. */
195 bool connmgr_has_in_band(struct connmgr *);
197 /* Fail-open and in-band implementation. */
198 void connmgr_flushed(struct connmgr *);
200 int connmgr_count_hidden_rules(const struct connmgr *);
202 /* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
204 struct ofconn *ofconn; /* Owning 'ofconn'. */
205 struct hmap_node ofconn_node; /* In ofconn's 'monitors' hmap. */
208 enum nx_flow_monitor_flags flags;
213 struct minimatch match;
216 struct ofputil_flow_monitor_request;
218 enum ofperr ofmonitor_create(const struct ofputil_flow_monitor_request *,
219 struct ofconn *, struct ofmonitor **)
220 OVS_REQUIRES(ofproto_mutex);
221 struct ofmonitor *ofmonitor_lookup(struct ofconn *, uint32_t id)
222 OVS_REQUIRES(ofproto_mutex);
223 void ofmonitor_destroy(struct ofmonitor *)
224 OVS_REQUIRES(ofproto_mutex);
226 void ofmonitor_report(struct connmgr *, struct rule *,
227 enum nx_flow_update_event, enum ofp_flow_removed_reason,
228 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid,
229 const struct rule_actions *old_actions)
230 OVS_REQUIRES(ofproto_mutex);
231 void ofmonitor_flush(struct connmgr *) OVS_REQUIRES(ofproto_mutex);
234 struct rule_collection;
235 void ofmonitor_collect_resume_rules(struct ofmonitor *, uint64_t seqno,
236 struct rule_collection *)
237 OVS_REQUIRES(ofproto_mutex);
238 void ofmonitor_compose_refresh_updates(struct rule_collection *rules,
239 struct ovs_list *msgs)
240 OVS_REQUIRES(ofproto_mutex);
242 #endif /* connmgr.h */