Merge 'master' into 'next'.
[sliver-openvswitch.git] / ofproto / ofproto.h
index 9a56bee..ea9f98b 100644 (file)
@@ -31,9 +31,9 @@
 extern "C" {
 #endif
 
+struct cfm;
 struct cls_rule;
-struct nlattr;
-struct ofhooks;
+struct netdev;
 struct ofproto;
 struct shash;
 
@@ -92,18 +92,60 @@ struct ofproto_controller {
 #define DEFAULT_SERIAL_DESC "None"
 #define DEFAULT_DP_DESC "None"
 
+void ofproto_enumerate_types(struct sset *types);
+const char *ofproto_normalize_type(const char *);
+
+int ofproto_enumerate_names(const char *type, struct sset *names);
+void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
+
 int ofproto_create(const char *datapath, const char *datapath_type,
-                   const struct ofhooks *, void *aux,
                    struct ofproto **ofprotop);
 void ofproto_destroy(struct ofproto *);
+int ofproto_delete(const char *name, const char *type);
+
 int ofproto_run(struct ofproto *);
-int ofproto_run1(struct ofproto *);
-int ofproto_run2(struct ofproto *, bool revalidate_all);
 void ofproto_wait(struct ofproto *);
 bool ofproto_is_alive(const struct ofproto *);
 
-int ofproto_port_del(struct ofproto *, uint16_t odp_port);
-bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
+/* A port within an OpenFlow switch.
+ *
+ * 'name' and 'type' are suitable for passing to netdev_open(). */
+struct ofproto_port {
+    char *name;                 /* Network device name, e.g. "eth0". */
+    char *type;                 /* Network device type, e.g. "system". */
+    uint16_t ofp_port;          /* OpenFlow port number. */
+};
+void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
+void ofproto_port_destroy(struct ofproto_port *);
+
+struct ofproto_port_dump {
+    const struct ofproto *ofproto;
+    int error;
+    void *state;
+};
+void ofproto_port_dump_start(struct ofproto_port_dump *,
+                             const struct ofproto *);
+bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
+int ofproto_port_dump_done(struct ofproto_port_dump *);
+
+/* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
+ *
+ * Arguments all have pointer type.
+ *
+ * If you break out of the loop, then you need to free the dump structure by
+ * hand using ofproto_port_dump_done(). */
+#define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
+    for (ofproto_port_dump_start(DUMP, OFPROTO);            \
+         (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
+          ? true                                            \
+          : (ofproto_port_dump_done(DUMP), false));         \
+        )
+
+int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
+int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
+
+int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
+                               struct ofproto_port *);
 
 /* Top-level configuration. */
 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
@@ -121,52 +163,74 @@ void ofproto_set_desc(struct ofproto *,
 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
 int ofproto_set_netflow(struct ofproto *,
                         const struct netflow_options *nf_options);
-void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
+int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 
-/* Configuration of individual interfaces. */
-struct cfm;
+/* Configuration of ports. */
+
+void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port);
+
+void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port);
+void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port,
+                          const struct cfm *,
+                          const uint16_t *remote_mps, size_t n_remote_mps);
+const struct cfm *ofproto_port_get_cfm(struct ofproto *, uint16_t ofp_port);
+int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
 
-void ofproto_iface_clear_cfm(struct ofproto *, uint32_t port_no);
-void ofproto_iface_set_cfm(struct ofproto *, uint32_t port_no,
-                           const struct cfm *,
-                           const uint16_t *remote_mps, size_t n_remote_mps);
-const struct cfm *ofproto_iface_get_cfm(struct ofproto *, uint32_t port_no);
+/* Configuration of bundles. */
+struct ofproto_bundle_settings {
+    char *name;                 /* For use in log messages. */
+
+    uint16_t *slaves;           /* OpenFlow port numbers for slaves. */
+    size_t n_slaves;
+
+    int vlan;                   /* VLAN if access port, -1 if trunk port. */
+    unsigned long *trunks;      /* vlan_bitmap, NULL to trunk all VLANs. */
+
+    struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
+    uint32_t *bond_stable_ids;  /* Array of n_slaves elements. */
+
+    struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
+    struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
+};
+
+int ofproto_bundle_register(struct ofproto *, void *aux,
+                            const struct ofproto_bundle_settings *);
+int ofproto_bundle_unregister(struct ofproto *, void *aux);
+
+/* Configuration of mirrors. */
+struct ofproto_mirror_settings {
+    /* Name for log messages. */
+    char *name;
+
+    /* Bundles that select packets for mirroring upon ingress.  */
+    void **srcs;                /* A set of registered ofbundle handles. */
+    size_t n_srcs;
+
+    /* Bundles that select packets for mirroring upon egress.  */
+    void **dsts;                /* A set of registered ofbundle handles. */
+    size_t n_dsts;
+
+    /* VLANs of packets to select for mirroring. */
+    unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
+
+    /* Output (mutually exclusive). */
+    void *out_bundle;           /* A registered ofbundle handle or NULL. */
+    uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
+};
+
+int ofproto_mirror_register(struct ofproto *, void *aux,
+                            const struct ofproto_mirror_settings *);
+int ofproto_mirror_unregister(struct ofproto *, void *aux);
+
+int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
+bool ofproto_is_mirror_output_bundle(struct ofproto *, void *aux);
 
 /* Configuration querying. */
-uint64_t ofproto_get_datapath_id(const struct ofproto *);
-bool ofproto_has_primary_controller(const struct ofproto *);
-enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
-void ofproto_get_listeners(const struct ofproto *, struct sset *);
 bool ofproto_has_snoops(const struct ofproto *);
 void ofproto_get_snoops(const struct ofproto *, struct sset *);
 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
-
-/* Functions for use by ofproto implementation modules, not by clients. */
-int ofproto_send_packet(struct ofproto *, uint32_t port_no, uint16_t vlan_tci,
-                        const struct ofpbuf *);
-void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
-                      const union ofp_action *, size_t n_actions);
-void ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
-void ofproto_flush_flows(struct ofproto *);
-
-/* Hooks for ovs-vswitchd. */
-struct ofhooks {
-    bool (*normal_cb)(const struct flow *, const struct ofpbuf *packet,
-                      struct ofpbuf *odp_actions, tag_type *,
-                      uint16_t *nf_output_iface, void *aux);
-    bool (*special_cb)(const struct flow *flow, const struct ofpbuf *packet,
-                       void *aux);
-    void (*account_flow_cb)(const struct flow *, tag_type tags,
-                            const struct nlattr *odp_actions,
-                            size_t actions_len,
-                            uint64_t n_bytes, void *aux);
-    void (*account_checkpoint_cb)(void *aux);
-
-    uint16_t (*autopath_cb)(const struct flow *, uint32_t id,
-                            tag_type *, void *aux);
-};
-void ofproto_revalidate(struct ofproto *, tag_type);
-struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
+void ofproto_get_netflow_ids(const struct ofproto *,
+                             uint8_t *engine_type, uint8_t *engine_id);
 
 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
 void ofproto_free_ofproto_controller_info(struct shash *);