ofproto/connmgr.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
   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 "classifier.h"
  21 #include "hmap.h"
  22 #include "list.h"
  23 #include "match.h"
  24 #include "ofp-errors.h"
  25 #include "ofp-util.h"
  26 #include "ofproto.h"
  27 #include "ofproto-provider.h"
  28 #include "openflow/nicira-ext.h"
  29 #include "openvswitch/types.h"
  30
  31 struct nlattr;
  32 struct ofconn;
  33 struct rule;
  34 struct simap;
  35 struct sset;
  36
  37 /* ofproto supports two kinds of OpenFlow connections:
  38  *
  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.
  42  *
  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.
  46  *
  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
  50  * common case.
  51  */
  52 enum ofconn_type {
  53     OFCONN_PRIMARY,             /* An ordinary OpenFlow controller. */
  54     OFCONN_SERVICE              /* A service connection, e.g. "ovs-ofctl". */
  55 };
  56
  57 /* A packet_in, with extra members to assist in queuing and routing it. */
  58 struct ofproto_packet_in {
  59     struct ofputil_packet_in up;
  60     struct ovs_list list_node;  /* For queuing. */
  61     uint16_t controller_id;     /* Controller ID to send to. */
  62     int max_len;                /* From action, or -1 if none. */
  63 };
  64
  65 /* Basics. */
  66 struct connmgr *connmgr_create(struct ofproto *ofproto,
  67                                const char *dpif_name, const char *local_name);
  68 void connmgr_destroy(struct connmgr *);
  69
  70 void connmgr_run(struct connmgr *,
  71                  void (*handle_openflow)(struct ofconn *,
  72                                          const struct ofpbuf *ofp_msg));
  73 void connmgr_wait(struct connmgr *);
  74
  75 void connmgr_get_memory_usage(const struct connmgr *, struct simap *usage);
  76
  77 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
  78
  79 void connmgr_retry(struct connmgr *);
  80
  81 /* OpenFlow configuration. */
  82 bool connmgr_has_controllers(const struct connmgr *);
  83 void connmgr_get_controller_info(struct connmgr *, struct shash *);
  84 void connmgr_free_controller_info(struct shash *);
  85 void connmgr_set_controllers(struct connmgr *,
  86                              const struct ofproto_controller[], size_t n,
  87                              uint32_t allowed_versions);
  88 void connmgr_reconnect(const struct connmgr *);
  89
  90 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
  91 bool connmgr_has_snoops(const struct connmgr *);
  92 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
  93
  94 /* Individual connections to OpenFlow controllers. */
  95 enum ofconn_type ofconn_get_type(const struct ofconn *);
  96
  97 bool ofconn_get_master_election_id(const struct ofconn *, uint64_t *idp);
  98 bool ofconn_set_master_election_id(struct ofconn *, uint64_t);
  99 enum ofp12_controller_role ofconn_get_role(const struct ofconn *);
 100 void ofconn_set_role(struct ofconn *, enum ofp12_controller_role);
 101
 102 enum ofputil_protocol ofconn_get_protocol(const struct ofconn *);
 103 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
 104
 105 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
 106 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
 107
 108 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
 109
 110 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
 111 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
 112
 113 int ofconn_get_miss_send_len(const struct ofconn *);
 114 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
 115
 116 void ofconn_set_async_config(struct ofconn *,
 117                              const struct ofputil_async_cfg *);
 118 struct ofputil_async_cfg ofconn_get_async_config(const struct ofconn *);
 119
 120 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
 121 void ofconn_send_replies(const struct ofconn *, struct ovs_list *);
 122 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
 123                        enum ofperr);
 124
 125 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
 126                                    struct dp_packet **bufferp, ofp_port_t *in_port);
 127
 128 struct ofp_bundle;
 129
 130 struct ofp_bundle *ofconn_get_bundle(struct ofconn *, uint32_t id);
 131 enum ofperr ofconn_insert_bundle(struct ofconn *, struct ofp_bundle *);
 132 enum ofperr ofconn_remove_bundle(struct ofconn *, struct ofp_bundle *);
 133
 134 /* Logging flow_mod summaries. */
 135 void ofconn_report_flow_mod(struct ofconn *, enum ofp_flow_mod_command);
 136
 137 /* Sending asynchronous messages. */
 138 bool connmgr_wants_packet_in_on_miss(struct connmgr *mgr);
 139 void connmgr_send_port_status(struct connmgr *, struct ofconn *source,
 140                               const struct ofputil_phy_port *, uint8_t reason);
 141 void connmgr_send_flow_removed(struct connmgr *,
 142                                const struct ofputil_flow_removed *);
 143 void connmgr_send_packet_in(struct connmgr *,
 144                             const struct ofproto_packet_in *);
 145 void ofconn_send_role_status(struct ofconn *ofconn, uint32_t role,
 146                              uint8_t reason);
 147
 148 void connmgr_send_requestforward(struct connmgr *, const struct ofconn *source,
 149                                  const struct ofputil_requestforward *);
 150
 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);
 154
 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 *);
 160
 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);
 165
 166 /* In-band implementation. */
 167 bool connmgr_has_in_band(struct connmgr *);
 168
 169 /* Fail-open and in-band implementation. */
 170 void connmgr_flushed(struct connmgr *);
 171
 172 int connmgr_count_hidden_rules(const struct connmgr *);
 173
 174 /* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
 175 struct ofmonitor {
 176     struct ofconn *ofconn;      /* Owning 'ofconn'. */
 177     struct hmap_node ofconn_node; /* In ofconn's 'monitors' hmap. */
 178     uint32_t id;
 179
 180     enum nx_flow_monitor_flags flags;
 181
 182     /* Matching. */
 183     ofp_port_t out_port;
 184     uint8_t table_id;
 185     struct minimatch match;
 186 };
 187
 188 struct ofputil_flow_monitor_request;
 189
 190 enum ofperr ofmonitor_create(const struct ofputil_flow_monitor_request *,
 191                              struct ofconn *, struct ofmonitor **)
 192     OVS_REQUIRES(ofproto_mutex);
 193 struct ofmonitor *ofmonitor_lookup(struct ofconn *, uint32_t id)
 194     OVS_REQUIRES(ofproto_mutex);
 195 void ofmonitor_destroy(struct ofmonitor *)
 196     OVS_REQUIRES(ofproto_mutex);
 197
 198 void ofmonitor_report(struct connmgr *, struct rule *,
 199                       enum nx_flow_update_event, enum ofp_flow_removed_reason,
 200                       const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid,
 201                       const struct rule_actions *old_actions)
 202     OVS_REQUIRES(ofproto_mutex);
 203 void ofmonitor_flush(struct connmgr *) OVS_REQUIRES(ofproto_mutex);
 204
 205
 206 struct rule_collection;
 207 void ofmonitor_collect_resume_rules(struct ofmonitor *, uint64_t seqno,
 208                                     struct rule_collection *)
 209     OVS_REQUIRES(ofproto_mutex);
 210 void ofmonitor_compose_refresh_updates(struct rule_collection *rules,
 211                                        struct ovs_list *msgs)
 212     OVS_REQUIRES(ofproto_mutex);
 213
 214 #endif /* connmgr.h */