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.
20 #include "classifier.h"
24 #include "ofp-errors.h"
27 #include "openflow/nicira-ext.h"
28 #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 /* A packet_in, with extra members to assist in queuing and routing it. */
66 struct ofproto_packet_in {
67 struct ofputil_packet_in up;
68 struct list list_node; /* For queuing. */
69 uint16_t controller_id; /* Controller ID to send to. */
73 struct connmgr *connmgr_create(struct ofproto *ofproto,
74 const char *dpif_name, const char *local_name);
75 void connmgr_destroy(struct connmgr *);
77 void connmgr_run(struct connmgr *,
78 bool (*handle_openflow)(struct ofconn *,
79 const struct ofpbuf *ofp_msg));
80 void connmgr_wait(struct connmgr *, bool handling_openflow);
82 void connmgr_get_memory_usage(const struct connmgr *, struct simap *usage);
84 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
86 void connmgr_retry(struct connmgr *);
88 /* OpenFlow configuration. */
89 bool connmgr_has_controllers(const struct connmgr *);
90 void connmgr_get_controller_info(struct connmgr *, struct shash *);
91 void connmgr_free_controller_info(struct shash *);
92 void connmgr_set_controllers(struct connmgr *,
93 const struct ofproto_controller[], size_t n,
94 uint32_t allowed_versions);
95 void connmgr_reconnect(const struct connmgr *);
97 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
98 bool connmgr_has_snoops(const struct connmgr *);
99 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
101 /* Individual connections to OpenFlow controllers. */
102 enum ofconn_type ofconn_get_type(const struct ofconn *);
104 bool ofconn_get_master_election_id(const struct ofconn *, uint64_t *idp);
105 bool ofconn_set_master_election_id(struct ofconn *, uint64_t);
106 enum ofp12_controller_role ofconn_get_role(const struct ofconn *);
107 void ofconn_set_role(struct ofconn *, enum ofp12_controller_role);
109 enum ofputil_protocol ofconn_get_protocol(const struct ofconn *);
110 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
112 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
113 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
115 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
117 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
118 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
120 int ofconn_get_miss_send_len(const struct ofconn *);
121 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
123 void ofconn_set_async_config(struct ofconn *,
124 const uint32_t master_masks[OAM_N_TYPES],
125 const uint32_t slave_masks[OAM_N_TYPES]);
126 void ofconn_get_async_config(struct ofconn *,
127 uint32_t *master_masks,
128 uint32_t *slave_masks);
130 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
131 void ofconn_send_replies(const struct ofconn *, struct list *);
132 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
135 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
136 struct ofpbuf **bufferp, ofp_port_t *in_port);
138 bool ofconn_has_pending_opgroups(const struct ofconn *);
139 void ofconn_add_opgroup(struct ofconn *, struct list *);
140 void ofconn_remove_opgroup(struct ofconn *, struct list *,
141 const struct ofp_header *request, int error);
143 /* Sending asynchronous messages. */
144 void connmgr_send_port_status(struct connmgr *,
145 const struct ofputil_phy_port *, uint8_t reason);
146 void connmgr_send_flow_removed(struct connmgr *,
147 const struct ofputil_flow_removed *);
148 void connmgr_send_packet_in(struct connmgr *,
149 const struct ofproto_packet_in *);
151 /* Fail-open settings. */
152 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
153 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
155 /* Fail-open implementation. */
156 int connmgr_get_max_probe_interval(const struct connmgr *);
157 bool connmgr_is_any_controller_connected(const struct connmgr *);
158 bool connmgr_is_any_controller_admitted(const struct connmgr *);
159 int connmgr_failure_duration(const struct connmgr *);
161 /* In-band configuration. */
162 void connmgr_set_extra_in_band_remotes(struct connmgr *,
163 const struct sockaddr_in *, size_t);
164 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
166 /* In-band implementation. */
167 bool connmgr_has_in_band(struct connmgr *);
169 /* Fail-open and in-band implementation. */
170 void connmgr_flushed(struct connmgr *);
172 /* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
174 struct ofconn *ofconn; /* Owning 'ofconn'. */
175 struct hmap_node ofconn_node; /* In ofconn's 'monitors' hmap. */
178 enum nx_flow_monitor_flags flags;
183 struct minimatch match;
186 struct ofputil_flow_monitor_request;
188 enum ofperr ofmonitor_create(const struct ofputil_flow_monitor_request *,
189 struct ofconn *, struct ofmonitor **)
190 OVS_REQUIRES(ofproto_mutex);
191 struct ofmonitor *ofmonitor_lookup(struct ofconn *, uint32_t id)
192 OVS_REQUIRES(ofproto_mutex);
193 void ofmonitor_destroy(struct ofmonitor *)
194 OVS_REQUIRES(ofproto_mutex);
196 void ofmonitor_report(struct connmgr *, struct rule *,
197 enum nx_flow_update_event, enum ofp_flow_removed_reason,
198 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
199 OVS_REQUIRES(ofproto_mutex);
200 void ofmonitor_flush(struct connmgr *) OVS_REQUIRES(ofproto_mutex);
203 struct rule_collection;
204 void ofmonitor_collect_resume_rules(struct ofmonitor *, uint64_t seqno,
205 struct rule_collection *)
206 OVS_REQUIRES(ofproto_mutex);
207 void ofmonitor_compose_refresh_updates(struct rule_collection *rules,
209 OVS_REQUIRES(ofproto_mutex);
211 #endif /* connmgr.h */