ofproto/connmgr.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 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 "openflow/nicira-ext.h"
  28 #include "openvswitch/types.h"
  29
  30 struct nlattr;
  31 struct ofconn;
  32 struct ofopgroup;
  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 /* 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. */
  62     OAM_N_TYPES
  63 };
  64
  65 /* A packet_in, with extra members to assist in queuing and routing it. */
  66 struct ofproto_packet_in {
  67     struct ofputil_packet_in up;
  68     struct list list_node;      /* For queuing. */
  69     uint16_t controller_id;     /* Controller ID to send to. */
  70     int send_len;               /* Length that the action requested sending. */
  71
  72     /* True if the packet_in was generated directly by a table-miss flow, that
  73      * is, a flow with priority 0 that wildcards all fields.  (Our
  74      * interpretation of "directly" is "not via groups".) */
  75     bool generated_by_table_miss;
  76 };
  77
  78 /* Basics. */
  79 struct connmgr *connmgr_create(struct ofproto *ofproto,
  80                                const char *dpif_name, const char *local_name);
  81 void connmgr_destroy(struct connmgr *);
  82
  83 void connmgr_run(struct connmgr *,
  84                  bool (*handle_openflow)(struct ofconn *,
  85                                          const struct ofpbuf *ofp_msg));
  86 void connmgr_wait(struct connmgr *, bool handling_openflow);
  87
  88 void connmgr_get_memory_usage(const struct connmgr *, struct simap *usage);
  89
  90 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
  91
  92 void connmgr_retry(struct connmgr *);
  93
  94 /* OpenFlow configuration. */
  95 bool connmgr_has_controllers(const struct connmgr *);
  96 void connmgr_get_controller_info(struct connmgr *, struct shash *);
  97 void connmgr_free_controller_info(struct shash *);
  98 void connmgr_set_controllers(struct connmgr *,
  99                              const struct ofproto_controller[], size_t n,
 100                              uint32_t allowed_versions);
 101 void connmgr_reconnect(const struct connmgr *);
 102
 103 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
 104 bool connmgr_has_snoops(const struct connmgr *);
 105 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
 106
 107 /* Individual connections to OpenFlow controllers. */
 108 enum ofconn_type ofconn_get_type(const struct ofconn *);
 109
 110 bool ofconn_get_master_election_id(const struct ofconn *, uint64_t *idp);
 111 bool ofconn_set_master_election_id(struct ofconn *, uint64_t);
 112 enum ofp12_controller_role ofconn_get_role(const struct ofconn *);
 113 void ofconn_set_role(struct ofconn *, enum ofp12_controller_role);
 114
 115 enum ofputil_protocol ofconn_get_protocol(const struct ofconn *);
 116 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
 117
 118 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
 119 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
 120
 121 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
 122
 123 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
 124 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
 125
 126 int ofconn_get_miss_send_len(const struct ofconn *);
 127 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
 128
 129 void ofconn_set_async_config(struct ofconn *,
 130                              const uint32_t master_masks[OAM_N_TYPES],
 131                              const uint32_t slave_masks[OAM_N_TYPES]);
 132 void ofconn_get_async_config(struct ofconn *,
 133                              uint32_t *master_masks,
 134                              uint32_t *slave_masks);
 135
 136 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
 137 void ofconn_send_replies(const struct ofconn *, struct list *);
 138 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
 139                        enum ofperr);
 140
 141 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
 142                                    struct ofpbuf **bufferp, ofp_port_t *in_port);
 143
 144 bool ofconn_has_pending_opgroups(const struct ofconn *);
 145 void ofconn_add_opgroup(struct ofconn *, struct list *);
 146 void ofconn_remove_opgroup(struct ofconn *, struct list *,
 147                            const struct ofp_header *request, int error);
 148
 149 /* Sending asynchronous messages. */
 150 void connmgr_send_port_status(struct connmgr *,
 151                               const struct ofputil_phy_port *, uint8_t reason);
 152 void connmgr_send_flow_removed(struct connmgr *,
 153                                const struct ofputil_flow_removed *);
 154 void connmgr_send_packet_in(struct connmgr *,
 155                             const struct ofproto_packet_in *);
 156 void ofconn_send_role_status(struct ofconn *ofconn, uint32_t role,
 157                              uint8_t reason);
 158
 159 /* Fail-open settings. */
 160 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
 161 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
 162
 163 /* Fail-open implementation. */
 164 int connmgr_get_max_probe_interval(const struct connmgr *);
 165 bool connmgr_is_any_controller_connected(const struct connmgr *);
 166 bool connmgr_is_any_controller_admitted(const struct connmgr *);
 167 int connmgr_failure_duration(const struct connmgr *);
 168
 169 /* In-band configuration. */
 170 void connmgr_set_extra_in_band_remotes(struct connmgr *,
 171                                        const struct sockaddr_in *, size_t);
 172 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
 173
 174 /* In-band implementation. */
 175 bool connmgr_has_in_band(struct connmgr *);
 176
 177 /* Fail-open and in-band implementation. */
 178 void connmgr_flushed(struct connmgr *);
 179
 180 /* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
 181 struct ofmonitor {
 182     struct ofconn *ofconn;      /* Owning 'ofconn'. */
 183     struct hmap_node ofconn_node; /* In ofconn's 'monitors' hmap. */
 184     uint32_t id;
 185
 186     enum nx_flow_monitor_flags flags;
 187
 188     /* Matching. */
 189     ofp_port_t out_port;
 190     uint8_t table_id;
 191     struct minimatch match;
 192 };
 193
 194 struct ofputil_flow_monitor_request;
 195
 196 enum ofperr ofmonitor_create(const struct ofputil_flow_monitor_request *,
 197                              struct ofconn *, struct ofmonitor **)
 198     OVS_REQUIRES(ofproto_mutex);
 199 struct ofmonitor *ofmonitor_lookup(struct ofconn *, uint32_t id)
 200     OVS_REQUIRES(ofproto_mutex);
 201 void ofmonitor_destroy(struct ofmonitor *)
 202     OVS_REQUIRES(ofproto_mutex);
 203
 204 void ofmonitor_report(struct connmgr *, struct rule *,
 205                       enum nx_flow_update_event, enum ofp_flow_removed_reason,
 206                       const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
 207     OVS_REQUIRES(ofproto_mutex);
 208 void ofmonitor_flush(struct connmgr *) OVS_REQUIRES(ofproto_mutex);
 209
 210
 211 struct rule_collection;
 212 void ofmonitor_collect_resume_rules(struct ofmonitor *, uint64_t seqno,
 213                                     struct rule_collection *)
 214     OVS_REQUIRES(ofproto_mutex);
 215 void ofmonitor_compose_refresh_updates(struct rule_collection *rules,
 216                                        struct list *msgs)
 217     OVS_REQUIRES(ofproto_mutex);
 218
 219 #endif /* connmgr.h */