Global replace of Nicira Networks.

[sliver-openvswitch.git] / lib / learning-switch.h

diff --git a/lib/learning-switch.h b/lib/learning-switch.h
index 5f2f36e..e42aec1 100644 (file)
--- a/lib/learning-switch.h
+++ b/lib/learning-switch.h
@@ -1,29 +1,67 @@
 /*
- * Copyright (c) 2008 Nicira Networks.
+ * Copyright (c) 2008, 2010, 2011 Nicira, Inc.
  *
- * Permission to use, copy, modify, and/or distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 #ifndef LEARNING_SWITCH_H
 #define LEARNING_SWITCH_H 1
 
 #include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
 
 struct ofpbuf;
 struct rconn;
 
-struct lswitch *lswitch_create(struct rconn *, bool learn_macs, int max_idle);
-void lswitch_run(struct lswitch *, struct rconn *);
+enum lswitch_mode {
+    LSW_NORMAL,                 /* Always use OFPP_NORMAL. */
+    LSW_FLOOD,                  /* Always use OFPP_FLOOD. */
+    LSW_LEARN                   /* Learn MACs at controller. */
+};
+
+struct lswitch_config {
+    enum lswitch_mode mode;
+
+    /* 0 to use exact-match flow entries,
+     * a OFPFW_* bitmask to enable specific wildcards,
+     * or UINT32_MAX to use the default wildcards (wildcarding as many fields
+     * as possible.
+     *
+     * Ignored when max_idle < 0 (in which case no flows are set up). */
+    uint32_t wildcards;
+
+    /* <0: Process every packet at the controller.
+     * >=0: Expire flows after they are unused for 'max_idle' seconds.
+     * OFP_FLOW_PERMANENT: Set up permanent flows. */
+    int max_idle;
+
+    /* Optional "flow mod" requests to send to the switch at connection time,
+     * to set up the flow table. */
+    const struct ofputil_flow_mod *default_flows;
+    size_t n_default_flows;
+
+    /* The OpenFlow queue to use by default.  Use UINT32_MAX to avoid
+     * specifying a particular queue. */
+    uint32_t default_queue;
+
+    /* Maps from a port name to a queue_id (cast to void *). */
+    const struct shash *port_queues;
+};
+
+struct lswitch *lswitch_create(struct rconn *, const struct lswitch_config *);
+void lswitch_set_queue(struct lswitch *sw, uint32_t queue);
+void lswitch_run(struct lswitch *);
 void lswitch_wait(struct lswitch *);
 void lswitch_destroy(struct lswitch *);
 void lswitch_process_packet(struct lswitch *, struct rconn *,