2 * Copyright (c) 2009, 2010, 2011 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.
23 #include "openflow/nicira-ext.h"
24 #include "openvswitch/types.h"
28 struct ofputil_flow_removed;
30 /* ofproto supports two kinds of OpenFlow connections:
32 * - "Primary" connections to ordinary OpenFlow controllers. ofproto
33 * maintains persistent connections to these controllers and by default
34 * sends them asynchronous messages such as packet-ins.
36 * - "Service" connections, e.g. from ovs-ofctl. When these connections
37 * drop, it is the other side's responsibility to reconnect them if
38 * necessary. ofproto does not send them asynchronous messages by default.
40 * Currently, active (tcp, ssl, unix) connections are always "primary"
41 * connections and passive (ptcp, pssl, punix) connections are always "service"
42 * connections. There is no inherent reason for this, but it reflects the
46 OFCONN_PRIMARY, /* An ordinary OpenFlow controller. */
47 OFCONN_SERVICE /* A service connection, e.g. "ovs-ofctl". */
51 struct connmgr *connmgr_create(struct ofproto *ofproto,
52 const char *dpif_name, const char *local_name);
53 void connmgr_destroy(struct connmgr *);
55 void connmgr_run(struct connmgr *,
56 void (*handle_openflow)(struct ofconn *,
57 struct ofpbuf *ofp_msg));
58 void connmgr_wait(struct connmgr *);
60 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
62 /* OpenFlow configuration. */
63 bool connmgr_has_controllers(const struct connmgr *);
64 void connmgr_get_controller_info(struct connmgr *, struct shash *);
65 void connmgr_set_controllers(struct connmgr *,
66 const struct ofproto_controller[], size_t n);
67 void connmgr_reconnect(const struct connmgr *);
69 int connmgr_set_snoops(struct connmgr *, const struct svec *snoops);
70 void connmgr_get_snoops(const struct connmgr *, struct svec *snoops);
72 /* Individual connections to OpenFlow controllers. */
73 enum ofconn_type ofconn_get_type(const struct ofconn *);
75 enum nx_role ofconn_get_role(const struct ofconn *);
76 void ofconn_set_role(struct ofconn *, enum nx_role);
78 enum nx_flow_format ofconn_get_flow_format(struct ofconn *);
79 void ofconn_set_flow_format(struct ofconn *, enum nx_flow_format);
81 int ofconn_get_miss_send_len(const struct ofconn *);
82 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
84 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
86 int ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
87 struct ofpbuf **bufferp, uint16_t *in_port);
89 /* Sending asynchronous messages. */
90 void connmgr_send_port_status(struct connmgr *, const struct ofp_phy_port *,
92 void connmgr_send_flow_removed(struct connmgr *,
93 const struct ofputil_flow_removed *);
94 void connmgr_send_packet_in(struct connmgr *, const struct dpif_upcall *,
95 const struct flow *, struct ofpbuf *rw_packet);
97 /* Fail-open settings. */
98 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
99 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
101 /* Fail-open implementation. */
102 int connmgr_get_max_probe_interval(const struct connmgr *);
103 bool connmgr_is_any_controller_connected(const struct connmgr *);
104 bool connmgr_is_any_controller_admitted(const struct connmgr *);
105 int connmgr_failure_duration(const struct connmgr *);
106 void connmgr_broadcast(struct connmgr *, struct ofpbuf *);
108 /* In-band configuration. */
109 void connmgr_set_extra_in_band_remotes(struct connmgr *,
110 const struct sockaddr_in *, size_t);
111 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
113 /* In-band implementation. */
114 bool connmgr_msg_in_hook(struct connmgr *, const struct flow *,
115 const struct ofpbuf *packet);
116 bool connmgr_may_set_up_flow(struct connmgr *, const struct flow *,
117 const struct nlattr *odp_actions,
120 /* Fail-open and in-band implementation. */
121 void connmgr_flushed(struct connmgr *);
123 #endif /* connmgr.h */