pintos-os.org Git - openvswitch/blob - ofproto/connmgr.h

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