2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
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.
22 #include "ofp-errors.h"
24 #include "openflow/nicira-ext.h"
25 #include "openvswitch/types.h"
30 struct ofputil_flow_removed;
31 struct ofputil_packet_in;
34 /* ofproto supports two kinds of OpenFlow connections:
36 * - "Primary" connections to ordinary OpenFlow controllers. ofproto
37 * maintains persistent connections to these controllers and by default
38 * sends them asynchronous messages such as packet-ins.
40 * - "Service" connections, e.g. from ovs-ofctl. When these connections
41 * drop, it is the other side's responsibility to reconnect them if
42 * necessary. ofproto does not send them asynchronous messages by default.
44 * Currently, active (tcp, ssl, unix) connections are always "primary"
45 * connections and passive (ptcp, pssl, punix) connections are always "service"
46 * connections. There is no inherent reason for this, but it reflects the
50 OFCONN_PRIMARY, /* An ordinary OpenFlow controller. */
51 OFCONN_SERVICE /* A service connection, e.g. "ovs-ofctl". */
54 /* The type of an OpenFlow asynchronous message. */
55 enum ofconn_async_msg_type {
56 OAM_PACKET_IN, /* OFPT_PACKET_IN or NXT_PACKET_IN. */
57 OAM_PORT_STATUS, /* OFPT_PORT_STATUS. */
58 OAM_FLOW_REMOVED, /* OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED. */
63 struct connmgr *connmgr_create(struct ofproto *ofproto,
64 const char *dpif_name, const char *local_name);
65 void connmgr_destroy(struct connmgr *);
67 void connmgr_run(struct connmgr *,
68 bool (*handle_openflow)(struct ofconn *,
69 struct ofpbuf *ofp_msg));
70 void connmgr_wait(struct connmgr *, bool handling_openflow);
72 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
74 void connmgr_retry(struct connmgr *);
76 /* OpenFlow configuration. */
77 bool connmgr_has_controllers(const struct connmgr *);
78 void connmgr_get_controller_info(struct connmgr *, struct shash *);
79 void connmgr_free_controller_info(struct shash *);
80 void connmgr_set_controllers(struct connmgr *,
81 const struct ofproto_controller[], size_t n);
82 void connmgr_reconnect(const struct connmgr *);
84 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
85 bool connmgr_has_snoops(const struct connmgr *);
86 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
88 /* Individual connections to OpenFlow controllers. */
89 enum ofconn_type ofconn_get_type(const struct ofconn *);
91 enum nx_role ofconn_get_role(const struct ofconn *);
92 void ofconn_set_role(struct ofconn *, enum nx_role);
94 enum ofputil_protocol ofconn_get_protocol(struct ofconn *);
95 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
97 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
98 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
100 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
102 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
103 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
105 int ofconn_get_miss_send_len(const struct ofconn *);
106 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
108 void ofconn_set_async_config(struct ofconn *,
109 const uint32_t master_masks[OAM_N_TYPES],
110 const uint32_t slave_masks[OAM_N_TYPES]);
112 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
113 void ofconn_send_replies(const struct ofconn *, struct list *);
114 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
117 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
118 struct ofpbuf **bufferp, uint16_t *in_port);
120 bool ofconn_has_pending_opgroups(const struct ofconn *);
121 void ofconn_add_opgroup(struct ofconn *, struct list *);
122 void ofconn_remove_opgroup(struct ofconn *, struct list *,
123 const struct ofp_header *request, int error);
125 /* Sending asynchronous messages. */
126 void connmgr_send_port_status(struct connmgr *, const struct ofp_phy_port *,
128 void connmgr_send_flow_removed(struct connmgr *,
129 const struct ofputil_flow_removed *);
130 void connmgr_send_packet_in(struct connmgr *, const struct ofputil_packet_in *,
131 const struct flow *);
133 /* Fail-open settings. */
134 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
135 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
137 /* Fail-open implementation. */
138 int connmgr_get_max_probe_interval(const struct connmgr *);
139 bool connmgr_is_any_controller_connected(const struct connmgr *);
140 bool connmgr_is_any_controller_admitted(const struct connmgr *);
141 int connmgr_failure_duration(const struct connmgr *);
142 void connmgr_broadcast(struct connmgr *, struct ofpbuf *);
144 /* In-band configuration. */
145 void connmgr_set_extra_in_band_remotes(struct connmgr *,
146 const struct sockaddr_in *, size_t);
147 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
149 /* In-band implementation. */
150 bool connmgr_msg_in_hook(struct connmgr *, const struct flow *,
151 const struct ofpbuf *packet);
152 bool connmgr_may_set_up_flow(struct connmgr *, const struct flow *,
153 const struct nlattr *odp_actions,
156 /* Fail-open and in-band implementation. */
157 void connmgr_flushed(struct connmgr *);
159 #endif /* connmgr.h */