Update copyright on all non-GPL files
[openvswitch] / switch / datapath.h
1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
2  * Junior University
3  * 
4  * We are making the OpenFlow specification and associated documentation
5  * (Software) available for public use and benefit with the expectation
6  * that others will use, modify and enhance the Software and contribute
7  * those enhancements back to the community. However, since we would
8  * like to make the Software available for broadest use, with as few
9  * restrictions as possible permission is hereby granted, free of
10  * charge, to any person obtaining a copy of this Software to deal in
11  * the Software under the copyrights without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE.
28  * 
29  * The name and trademarks of copyright holder(s) may NOT be used in
30  * advertising or publicity pertaining to the Software or any
31  * derivatives without specific, written prior permission.
32  */
33
34 /* Interface exported by OpenFlow module. */
35
36 #ifndef DATAPATH_H
37 #define DATAPATH_H 1
38
39 #include <time.h>
40 #include "openflow.h"
41 #include "switch-flow.h"
42 #include "buffer.h"
43 #include "list.h"
44
45 #define NL_FLOWS_PER_MESSAGE 100
46
47 /* Capabilities supported by this implementation. */
48 #define OFP_SUPPORTED_CAPABILITIES (OFPC_MULTI_PHY_TX)
49
50 /* Actions supported by this implementation. */
51 #define OFP_SUPPORTED_ACTIONS ( (1 << OFPAT_OUTPUT)         \
52                                 | (1 << OFPAT_SET_DL_VLAN)  \
53                                 | (1 << OFPAT_SET_DL_SRC)   \
54                                 | (1 << OFPAT_SET_DL_DST)   \
55                                 | (1 << OFPAT_SET_NW_SRC)   \
56                                 | (1 << OFPAT_SET_NW_DST)   \
57                                 | (1 << OFPAT_SET_TP_SRC)   \
58                                 | (1 << OFPAT_SET_TP_DST) )
59
60 struct sw_port {
61     uint32_t flags;
62     struct datapath *dp;
63     struct netdev *netdev;
64     struct list node; /* Element in datapath.ports. */
65 };
66
67 struct datapath {
68     struct controller_connection *cc;
69
70     time_t last_timeout;
71
72     /* Unique identifier for this datapath */
73     uint64_t  id;
74
75     struct sw_chain *chain;  /* Forwarding rules. */
76
77     /* Flags from the control hello message */
78     uint16_t hello_flags;
79
80     /* Maximum number of bytes that should be sent for flow misses */
81     uint16_t miss_send_len;
82
83     /* Switch ports. */
84     struct sw_port ports[OFPP_MAX];
85     struct list port_list; /* List of ports, for flooding. */
86 };
87
88 int dp_new(struct datapath **, uint64_t dpid, struct controller_connection *);
89 int dp_add_port(struct datapath *, const char *netdev);
90 void dp_run(struct datapath *);
91 void dp_wait(struct datapath *);
92
93 void dp_output_port(struct datapath *, struct buffer *,
94                     int in_port, int out_port);
95 void dp_output_control(struct datapath *, struct buffer *, int in_port,
96                        uint32_t buffer_id, size_t max_len, int reason);
97 void dp_send_hello(struct datapath *);
98 void dp_send_flow_expired(struct datapath *, struct sw_flow *);
99 void dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp);
100
101 #endif /* datapath.h */