Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / ofproto / connmgr.h
index 58b1ae3..7f69d4f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009, 2010, 2011 Nicira Networks.
+ * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #ifndef CONNMGR_H
 #define CONNMGR_H 1
 
+#include "classifier.h"
 #include "hmap.h"
 #include "list.h"
+#include "match.h"
+#include "ofp-errors.h"
+#include "ofp-util.h"
 #include "ofproto.h"
 #include "openflow/nicira-ext.h"
 #include "openvswitch/types.h"
 
+struct nlattr;
 struct ofconn;
 struct ofopgroup;
-struct ofputil_flow_removed;
-struct ofputil_packet_in;
+struct rule;
+struct simap;
 struct sset;
 
 /* ofproto supports two kinds of OpenFlow connections:
@@ -49,6 +54,42 @@ enum ofconn_type {
     OFCONN_SERVICE              /* A service connection, e.g. "ovs-ofctl". */
 };
 
+/* The type of an OpenFlow asynchronous message. */
+enum ofconn_async_msg_type {
+    OAM_PACKET_IN,              /* OFPT_PACKET_IN or NXT_PACKET_IN. */
+    OAM_PORT_STATUS,            /* OFPT_PORT_STATUS. */
+    OAM_FLOW_REMOVED,           /* OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED. */
+    OAM_N_TYPES
+};
+
+enum ofproto_packet_in_miss_type {
+    /* Not generated by a flow miss or table-miss flow. */
+    OFPROTO_PACKET_IN_NO_MISS,
+
+    /* The packet_in was generated directly by a table-miss flow, that is, a
+     * flow with priority 0 that wildcards all fields.  See OF1.3.3 section
+     * 5.4.
+     *
+     * (Our interpretation of "directly" is "not via groups".  Packet_ins
+     * generated by table-miss flows via groups use
+     * OFPROTO_PACKET_IN_NO_MISS.) */
+    OFPROTO_PACKET_IN_MISS_FLOW,
+
+    /* The packet-in was generated directly by a table-miss, but not a
+     * table-miss flow.  That is, it was generated by the OpenFlow 1.0, 1.1, or
+     * 1.2 table-miss behavior. */
+    OFPROTO_PACKET_IN_MISS_WITHOUT_FLOW,
+};
+
+/* A packet_in, with extra members to assist in queuing and routing it. */
+struct ofproto_packet_in {
+    struct ofputil_packet_in up;
+    struct list list_node;      /* For queuing. */
+    uint16_t controller_id;     /* Controller ID to send to. */
+    int send_len;               /* Length that the action requested sending. */
+    enum ofproto_packet_in_miss_type miss_type;
+};
+
 /* Basics. */
 struct connmgr *connmgr_create(struct ofproto *ofproto,
                                const char *dpif_name, const char *local_name);
@@ -56,9 +97,11 @@ void connmgr_destroy(struct connmgr *);
 
 void connmgr_run(struct connmgr *,
                  bool (*handle_openflow)(struct ofconn *,
-                                         struct ofpbuf *ofp_msg));
+                                         const struct ofpbuf *ofp_msg));
 void connmgr_wait(struct connmgr *, bool handling_openflow);
 
+void connmgr_get_memory_usage(const struct connmgr *, struct simap *usage);
+
 struct ofproto *ofconn_get_ofproto(const struct ofconn *);
 
 void connmgr_retry(struct connmgr *);
@@ -66,8 +109,10 @@ void connmgr_retry(struct connmgr *);
 /* OpenFlow configuration. */
 bool connmgr_has_controllers(const struct connmgr *);
 void connmgr_get_controller_info(struct connmgr *, struct shash *);
+void connmgr_free_controller_info(struct shash *);
 void connmgr_set_controllers(struct connmgr *,
-                             const struct ofproto_controller[], size_t n);
+                             const struct ofproto_controller[], size_t n,
+                             uint32_t allowed_versions);
 void connmgr_reconnect(const struct connmgr *);
 
 int connmgr_set_snoops(struct connmgr *, const struct sset *snoops);
@@ -77,39 +122,57 @@ void connmgr_get_snoops(const struct connmgr *, struct sset *snoops);
 /* Individual connections to OpenFlow controllers. */
 enum ofconn_type ofconn_get_type(const struct ofconn *);
 
-enum nx_role ofconn_get_role(const struct ofconn *);
-void ofconn_set_role(struct ofconn *, enum nx_role);
+bool ofconn_get_master_election_id(const struct ofconn *, uint64_t *idp);
+bool ofconn_set_master_election_id(struct ofconn *, uint64_t);
+enum ofp12_controller_role ofconn_get_role(const struct ofconn *);
+void ofconn_set_role(struct ofconn *, enum ofp12_controller_role);
+
+enum ofputil_protocol ofconn_get_protocol(const struct ofconn *);
+void ofconn_set_protocol(struct ofconn *, enum ofputil_protocol);
 
-enum nx_flow_format ofconn_get_flow_format(struct ofconn *);
-void ofconn_set_flow_format(struct ofconn *, enum nx_flow_format);
+enum nx_packet_in_format ofconn_get_packet_in_format(struct ofconn *);
+void ofconn_set_packet_in_format(struct ofconn *, enum nx_packet_in_format);
 
-bool ofconn_get_flow_mod_table_id(const struct ofconn *);
-void ofconn_set_flow_mod_table_id(struct ofconn *, bool enable);
+void ofconn_set_controller_id(struct ofconn *, uint16_t controller_id);
+
+void ofconn_set_invalid_ttl_to_controller(struct ofconn *, bool);
+bool ofconn_get_invalid_ttl_to_controller(struct ofconn *);
 
 int ofconn_get_miss_send_len(const struct ofconn *);
 void ofconn_set_miss_send_len(struct ofconn *, int miss_send_len);
 
+void ofconn_set_async_config(struct ofconn *,
+                             const uint32_t master_masks[OAM_N_TYPES],
+                             const uint32_t slave_masks[OAM_N_TYPES]);
+void ofconn_get_async_config(struct ofconn *,
+                             uint32_t *master_masks,
+                             uint32_t *slave_masks);
+
 void ofconn_send_reply(const struct ofconn *, struct ofpbuf *);
 void ofconn_send_replies(const struct ofconn *, struct list *);
 void ofconn_send_error(const struct ofconn *, const struct ofp_header *request,
-                       int error);
+                       enum ofperr);
 
-int ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
-                           struct ofpbuf **bufferp, uint16_t *in_port);
+enum ofperr ofconn_pktbuf_retrieve(struct ofconn *, uint32_t id,
+                                   struct ofpbuf **bufferp, ofp_port_t *in_port);
 
-size_t ofconn_n_pending_opgroups(const struct ofconn *);
 bool ofconn_has_pending_opgroups(const struct ofconn *);
 void ofconn_add_opgroup(struct ofconn *, struct list *);
 void ofconn_remove_opgroup(struct ofconn *, struct list *,
                            const struct ofp_header *request, int error);
 
+struct hmap *ofconn_get_bundles(struct ofconn *ofconn);
+
 /* Sending asynchronous messages. */
-void connmgr_send_port_status(struct connmgr *, const struct ofp_phy_port *,
-                              uint8_t reason);
+bool connmgr_wants_packet_in_on_miss(struct connmgr *mgr);
+void connmgr_send_port_status(struct connmgr *, struct ofconn *source,
+                              const struct ofputil_phy_port *, uint8_t reason);
 void connmgr_send_flow_removed(struct connmgr *,
                                const struct ofputil_flow_removed *);
-void connmgr_send_packet_in(struct connmgr *, const struct ofputil_packet_in *,
-                            const struct flow *, struct ofpbuf *rw_packet);
+void connmgr_send_packet_in(struct connmgr *,
+                            const struct ofproto_packet_in *);
+void ofconn_send_role_status(struct ofconn *ofconn, uint32_t role,
+                             uint8_t reason);
 
 /* Fail-open settings. */
 enum ofproto_fail_mode connmgr_get_fail_mode(const struct connmgr *);
@@ -120,7 +183,6 @@ int connmgr_get_max_probe_interval(const struct connmgr *);
 bool connmgr_is_any_controller_connected(const struct connmgr *);
 bool connmgr_is_any_controller_admitted(const struct connmgr *);
 int connmgr_failure_duration(const struct connmgr *);
-void connmgr_broadcast(struct connmgr *, struct ofpbuf *);
 
 /* In-band configuration. */
 void connmgr_set_extra_in_band_remotes(struct connmgr *,
@@ -128,13 +190,48 @@ void connmgr_set_extra_in_band_remotes(struct connmgr *,
 void connmgr_set_in_band_queue(struct connmgr *, int queue_id);
 
 /* In-band implementation. */
-bool connmgr_msg_in_hook(struct connmgr *, const struct flow *,
-                         const struct ofpbuf *packet);
-bool connmgr_may_set_up_flow(struct connmgr *, const struct flow *,
-                             const struct nlattr *odp_actions,
-                             size_t actions_len);
+bool connmgr_has_in_band(struct connmgr *);
 
 /* Fail-open and in-band implementation. */
 void connmgr_flushed(struct connmgr *);
 
+/* A flow monitor managed by NXST_FLOW_MONITOR and related requests. */
+struct ofmonitor {
+    struct ofconn *ofconn;      /* Owning 'ofconn'. */
+    struct hmap_node ofconn_node; /* In ofconn's 'monitors' hmap. */
+    uint32_t id;
+
+    enum nx_flow_monitor_flags flags;
+
+    /* Matching. */
+    ofp_port_t out_port;
+    uint8_t table_id;
+    struct minimatch match;
+};
+
+struct ofputil_flow_monitor_request;
+
+enum ofperr ofmonitor_create(const struct ofputil_flow_monitor_request *,
+                             struct ofconn *, struct ofmonitor **)
+    OVS_REQUIRES(ofproto_mutex);
+struct ofmonitor *ofmonitor_lookup(struct ofconn *, uint32_t id)
+    OVS_REQUIRES(ofproto_mutex);
+void ofmonitor_destroy(struct ofmonitor *)
+    OVS_REQUIRES(ofproto_mutex);
+
+void ofmonitor_report(struct connmgr *, struct rule *,
+                      enum nx_flow_update_event, enum ofp_flow_removed_reason,
+                      const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
+    OVS_REQUIRES(ofproto_mutex);
+void ofmonitor_flush(struct connmgr *) OVS_REQUIRES(ofproto_mutex);
+
+
+struct rule_collection;
+void ofmonitor_collect_resume_rules(struct ofmonitor *, uint64_t seqno,
+                                    struct rule_collection *)
+    OVS_REQUIRES(ofproto_mutex);
+void ofmonitor_compose_refresh_updates(struct rule_collection *rules,
+                                       struct list *msgs)
+    OVS_REQUIRES(ofproto_mutex);
+
 #endif /* connmgr.h */