6afad4fed01009aeb3857314eeb12d48ce10847e
[openvswitch] / switch / forward.h
1 /* Copyright (C) 2008 Board of Trustees, Leland Stanford Jr. University.
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a copy
4  * of this software and associated documentation files (the "Software"), to
5  * deal in the Software without restriction, including without limitation the
6  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7  * sell copies of the Software, and to permit persons to whom the Software is
8  * furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19  * IN THE SOFTWARE.
20  */
21
22 #ifndef FORWARD_H
23 #define FORWARD_H 1
24
25 #include <stddef.h>
26 #include <stdint.h>
27
28 struct buffer;
29 struct datapath;
30 struct ofp_action;
31 struct sw_flow_key;
32
33 /* Buffers are identified to userspace by a 31-bit opaque ID.  We divide the ID
34  * into a buffer number (low bits) and a cookie (high bits).  The buffer number
35  * is an index into an array of buffers.  The cookie distinguishes between
36  * different packets that have occupied a single buffer.  Thus, the more
37  * buffers we have, the lower-quality the cookie... */
38 #define PKT_BUFFER_BITS 8
39 #define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
40 #define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
41
42 #define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
43
44
45 void fwd_port_input(struct datapath *, struct buffer *, int in_port);
46 int fwd_control_input(struct datapath *, const void *, size_t);
47
48 uint32_t fwd_save_buffer(struct buffer *);
49
50 void fwd_exit(void);
51
52 struct buffer *execute_setter(struct buffer *, uint16_t,
53                               const struct sw_flow_key *,
54                               const struct ofp_action *);
55
56 #endif /* forward.h */