Add ability to direct "packet-in"s to particular controllers.
[openvswitch] / ofproto / connmgr.h
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef CONNMGR_H
18 #define CONNMGR_H 1
19
20 #include "hmap.h"
21 #include "list.h"
22 #include "ofp-errors.h"
23 #include "ofproto.h"
24 #include "openflow/nicira-ext.h"
25 #include "openvswitch/types.h"
26
27 struct nlattr;
28 struct ofconn;
29 struct ofopgroup;
30 struct ofputil_flow_removed;
31 struct ofputil_packet_in;
32 struct sset;
33
34 /* ofproto supports two kinds of OpenFlow connections:
35  *
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.
39  *
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.
43  *
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
47  * common case.
48  */
49 enum ofconn_type {
50     OFCONN_PRIMARY,             /* An ordinary OpenFlow controller. */
51     OFCONN_SERVICE              /* A service connection, e.g. "ovs-ofctl". */
52 };
53
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. */
59     OAM_N_TYPES
60 };
61
62 /* Basics. */
63 struct connmgr *connmgr_create(struct ofproto *ofproto,
64                                const char *dpif_name, const char *local_name);
65 void connmgr_destroy(struct connmgr *);
66
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);
71
72 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
73
74 void connmgr_retry(struct connmgr *);
75
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 *);
83
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);
87
88 /* Individual connections to OpenFlow controllers. */
89 enum ofconn_type ofconn_get_type(const struct ofconn *);
90
91 enum nx_role ofconn_get_role(const struct ofconn *);
92 void ofconn_set_role(struct ofconn *, enum nx_role);
93
94 enum nx_flow_format ofconn_get_flow_format(struct ofconn *);
95 void ofconn_set_flow_format(struct ofconn *, enum nx_flow_format);
96
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);
99
100 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
101
102 bool ofconn_get_flow_mod_table_id(const struct ofconn *);
103 void ofconn_set_flow_mod_table_id(struct ofconn *, bool enable);
104
105 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
106 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
107
108 int ofconn_get_miss_send_len(const struct ofconn *);
109 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
110
111 void ofconn_set_async_config(struct ofconn *,
112                              const uint32_t master_masks[OAM_N_TYPES],
113                              const uint32_t slave_masks[OAM_N_TYPES]);
114
115 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
116 void ofconn_send_replies(const struct ofconn *, struct list *);
117 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
118                        enum ofperr);
119
120 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
121                                    struct ofpbuf **bufferp, uint16_t *in_port);
122
123 bool ofconn_has_pending_opgroups(const struct ofconn *);
124 void ofconn_add_opgroup(struct ofconn *, struct list *);
125 void ofconn_remove_opgroup(struct ofconn *, struct list *,
126                            const struct ofp_header *request, int error);
127
128 /* Sending asynchronous messages. */
129 void connmgr_send_port_status(struct connmgr *, const struct ofp_phy_port *,
130                               uint8_t reason);
131 void connmgr_send_flow_removed(struct connmgr *,
132                                const struct ofputil_flow_removed *);
133 void connmgr_send_packet_in(struct connmgr *, const struct ofputil_packet_in *,
134                             const struct flow *);
135
136 /* Fail-open settings. */
137 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
138 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
139
140 /* Fail-open implementation. */
141 int connmgr_get_max_probe_interval(const struct connmgr *);
142 bool connmgr_is_any_controller_connected(const struct connmgr *);
143 bool connmgr_is_any_controller_admitted(const struct connmgr *);
144 int connmgr_failure_duration(const struct connmgr *);
145 void connmgr_broadcast(struct connmgr *, struct ofpbuf *);
146
147 /* In-band configuration. */
148 void connmgr_set_extra_in_band_remotes(struct connmgr *,
149                                        const struct sockaddr_in *, size_t);
150 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
151
152 /* In-band implementation. */
153 bool connmgr_msg_in_hook(struct connmgr *, const struct flow *,
154                          const struct ofpbuf *packet);
155 bool connmgr_may_set_up_flow(struct connmgr *, const struct flow *,
156                              const struct nlattr *odp_actions,
157                              size_t actions_len);
158
159 /* Fail-open and in-band implementation. */
160 void connmgr_flushed(struct connmgr *);
161
162 #endif /* connmgr.h */