classifier: Omit all-1-bits mask for VLAN TCI in cls_rule_format().
[sliver-openvswitch.git] / lib / learning-switch.h
1 /*
2  * Copyright (c) 2008, 2010 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 LEARNING_SWITCH_H
18 #define LEARNING_SWITCH_H 1
19
20 #include <stdbool.h>
21 #include <stdint.h>
22 #include <stdio.h>
23
24 struct ofpbuf;
25 struct rconn;
26
27 enum lswitch_mode {
28     LSW_NORMAL,                 /* Always use OFPP_NORMAL. */
29     LSW_FLOOD,                  /* Always use OFPP_FLOOD. */
30     LSW_LEARN                   /* Learn MACs at controller. */
31 };
32
33 struct lswitch_config {
34     enum lswitch_mode mode;
35
36     /* Set up only exact-match flows? */
37     bool exact_flows;
38
39     /* <0: Process every packet at the controller.
40      * >=0: Expire flows after they are unused for 'max_idle' seconds.
41      * OFP_FLOW_PERMANENT: Set up permanent flows. */
42     int max_idle;
43
44     /* Optionally, a list of one or more "struct ofpbuf"s containing OpenFlow
45      * messages to send to the switch at time of connection.  Presumably these
46      * will be OFPT_FLOW_MOD requests to set up the flow table. */
47     const struct list *default_flows;
48
49     /* The OpenFlow queue to use by default.  Use UINT32_MAX to avoid
50      * specifying a particular queue. */
51     uint32_t default_queue;
52
53     /* Maps from a port name to a queue_id (cast to void *). */
54     const struct shash *port_queues;
55 };
56
57 struct lswitch *lswitch_create(struct rconn *, const struct lswitch_config *);
58 void lswitch_set_queue(struct lswitch *sw, uint32_t queue);
59 void lswitch_run(struct lswitch *);
60 void lswitch_wait(struct lswitch *);
61 void lswitch_destroy(struct lswitch *);
62 void lswitch_process_packet(struct lswitch *, struct rconn *,
63                             const struct ofpbuf *);
64
65
66 #endif /* learning-switch.h */