ofproto/connmgr.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 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 "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 ofputil_phy_port;
  33 struct sset;
  34
  35 /* ofproto supports two kinds of OpenFlow connections:
  36  *
  37  *   - "Primary" connections to ordinary OpenFlow controllers.  ofproto
  38  *     maintains persistent connections to these controllers and by default
  39  *     sends them asynchronous messages such as packet-ins.
  40  *
  41  *   - "Service" connections, e.g. from ovs-ofctl.  When these connections
  42  *     drop, it is the other side's responsibility to reconnect them if
  43  *     necessary.  ofproto does not send them asynchronous messages by default.
  44  *
  45  * Currently, active (tcp, ssl, unix) connections are always "primary"
  46  * connections and passive (ptcp, pssl, punix) connections are always "service"
  47  * connections.  There is no inherent reason for this, but it reflects the
  48  * common case.
  49  */
  50 enum ofconn_type {
  51     OFCONN_PRIMARY,             /* An ordinary OpenFlow controller. */
  52     OFCONN_SERVICE              /* A service connection, e.g. "ovs-ofctl". */
  53 };
  54
  55 /* The type of an OpenFlow asynchronous message. */
  56 enum ofconn_async_msg_type {
  57     OAM_PACKET_IN,              /* OFPT_PACKET_IN or NXT_PACKET_IN. */
  58     OAM_PORT_STATUS,            /* OFPT_PORT_STATUS. */
  59     OAM_FLOW_REMOVED,           /* OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED. */
  60     OAM_N_TYPES
  61 };
  62
  63 /* Basics. */
  64 struct connmgr *connmgr_create(struct ofproto *ofproto,
  65                                const char *dpif_name, const char *local_name);
  66 void connmgr_destroy(struct connmgr *);
  67
  68 void connmgr_run(struct connmgr *,
  69                  bool (*handle_openflow)(struct ofconn *,
  70                                          struct ofpbuf *ofp_msg));
  71 void connmgr_wait(struct connmgr *, bool handling_openflow);
  72
  73 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
  74
  75 void connmgr_retry(struct connmgr *);
  76
  77 /* OpenFlow configuration. */
  78 bool connmgr_has_controllers(const struct connmgr *);
  79 void connmgr_get_controller_info(struct connmgr *, struct shash *);
  80 void connmgr_free_controller_info(struct shash *);
  81 void connmgr_set_controllers(struct connmgr *,
  82                              const struct ofproto_controller[], size_t n);
  83 void connmgr_reconnect(const struct connmgr *);
  84
  85 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
  86 bool connmgr_has_snoops(const struct connmgr *);
  87 void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
  88
  89 /* Individual connections to OpenFlow controllers. */
  90 enum ofconn_type ofconn_get_type(const struct ofconn *);
  91
  92 enum nx_role ofconn_get_role(const struct ofconn *);
  93 void ofconn_set_role(struct ofconn *, enum nx_role);
  94
  95 enum ofputil_protocol ofconn_get_protocol(struct ofconn *);
  96 void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
  97
  98 enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
  99 void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
 100
 101 void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
 102
 103 void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
 104 bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
 105
 106 int ofconn_get_miss_send_len(const struct ofconn *);
 107 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
 108
 109 void ofconn_set_async_config(struct ofconn *,
 110                              const uint32_t master_masks[OAM_N_TYPES],
 111                              const uint32_t slave_masks[OAM_N_TYPES]);
 112
 113 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
 114 void ofconn_send_replies(const struct ofconn *, struct list *);
 115 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
 116                        enum ofperr);
 117
 118 enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
 119                                    struct ofpbuf **bufferp, uint16_t *in_port);
 120
 121 bool ofconn_has_pending_opgroups(const struct ofconn *);
 122 void ofconn_add_opgroup(struct ofconn *, struct list *);
 123 void ofconn_remove_opgroup(struct ofconn *, struct list *,
 124                            const struct ofp_header *request, int error);
 125
 126 /* Sending asynchronous messages. */
 127 void connmgr_send_port_status(struct connmgr *,
 128                               const struct ofputil_phy_port *, uint8_t reason);
 129 void connmgr_send_flow_removed(struct connmgr *,
 130                                const struct ofputil_flow_removed *);
 131 void connmgr_send_packet_in(struct connmgr *,
 132                             const struct ofputil_packet_in *);
 133
 134 /* Fail-open settings. */
 135 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
 136 void connmgr_set_fail_mode(struct connmgr *, enum ofproto_fail_mode);
 137
 138 /* Fail-open implementation. */
 139 int connmgr_get_max_probe_interval(const struct connmgr *);
 140 bool connmgr_is_any_controller_connected(const struct connmgr *);
 141 bool connmgr_is_any_controller_admitted(const struct connmgr *);
 142 int connmgr_failure_duration(const struct connmgr *);
 143
 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);
 148
 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,
 154                              size_t actions_len);
 155
 156 /* Fail-open and in-band implementation. */
 157 void connmgr_flushed(struct connmgr *);
 158
 159 #endif /* connmgr.h */