2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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 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 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 bool (*handle_openflow
)(struct ofconn
*,
100 const struct ofpbuf
*ofp_msg
));
101 void connmgr_wait(struct connmgr
*, bool handling_openflow
);
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 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 ofpbuf
**bufferp
, ofp_port_t
*in_port
);
159 bool ofconn_has_pending_opgroups(const struct ofconn
*);
160 void ofconn_add_opgroup(struct ofconn
*, struct list
*);
161 void ofconn_remove_opgroup(struct ofconn
*, struct list
*,
162 const struct ofp_header
*request
, int error
);
164 /* Sending asynchronous messages. */
165 void connmgr_send_port_status(struct connmgr
*, struct ofconn
*source
,
166 const struct ofputil_phy_port
*, uint8_t reason
);
167 void connmgr_send_flow_removed(struct connmgr
*,
168 const struct ofputil_flow_removed
*);
169 void connmgr_send_packet_in(struct connmgr
*,
170 const struct ofproto_packet_in
*);
171 void ofconn_send_role_status(struct ofconn
*ofconn
, uint32_t role
,
174 /* Fail-open settings. */
175 enum ofproto_fail_mode
connmgr_get_fail_mode(const struct connmgr
*);
176 void connmgr_set_fail_mode(struct connmgr
*, enum ofproto_fail_mode
);
178 /* Fail-open implementation. */
179 int connmgr_get_max_probe_interval(const struct connmgr
*);
180 bool connmgr_is_any_controller_connected(const struct connmgr
*);
181 bool connmgr_is_any_controller_admitted(const struct connmgr
*);
182 int connmgr_failure_duration(const struct connmgr
*);
184 /* In-band configuration. */
185 void connmgr_set_extra_in_band_remotes(struct connmgr
*,
186 const struct sockaddr_in
*, size_t);
187 void connmgr_set_in_band_queue(struct connmgr
*, int queue_id
);
189 /* In-band implementation. */
190 bool connmgr_has_in_band(struct connmgr
*);
192 /* Fail-open and in-band implementation. */
193 void connmgr_flushed(struct connmgr
*);
195 /* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
197 struct ofconn
*ofconn
; /* Owning 'ofconn'. */
198 struct hmap_node ofconn_node
; /* In ofconn's 'monitors' hmap. */
201 enum nx_flow_monitor_flags flags
;
206 struct minimatch match
;
209 struct ofputil_flow_monitor_request
;
211 enum ofperr
ofmonitor_create(const struct ofputil_flow_monitor_request
*,
212 struct ofconn
*, struct ofmonitor
**)
213 OVS_REQUIRES(ofproto_mutex
);
214 struct ofmonitor
*ofmonitor_lookup(struct ofconn
*, uint32_t id
)
215 OVS_REQUIRES(ofproto_mutex
);
216 void ofmonitor_destroy(struct ofmonitor
*)
217 OVS_REQUIRES(ofproto_mutex
);
219 void ofmonitor_report(struct connmgr
*, struct rule
*,
220 enum nx_flow_update_event
, enum ofp_flow_removed_reason
,
221 const struct ofconn
*abbrev_ofconn
, ovs_be32 abbrev_xid
)
222 OVS_REQUIRES(ofproto_mutex
);
223 void ofmonitor_flush(struct connmgr
*) OVS_REQUIRES(ofproto_mutex
);
226 struct rule_collection
;
227 void ofmonitor_collect_resume_rules(struct ofmonitor
*, uint64_t seqno
,
228 struct rule_collection
*)
229 OVS_REQUIRES(ofproto_mutex
);
230 void ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
232 OVS_REQUIRES(ofproto_mutex
);
234 #endif /* connmgr.h */