Fix uninitialized data read in secchan.
[openvswitch] / switch / switch-flow.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 #ifndef SWITCH_FLOW_H
35 #define SWITCH_FLOW_H 1
36
37 #include <time.h>
38 #include "flow.h"
39 #include "list.h"
40
41 struct ofp_match;
42
43 /* Identification data for a flow. */
44 struct sw_flow_key {
45     struct flow flow;           /* Flow data (in network byte order). */
46     uint32_t wildcards;         /* Wildcard fields (in host byte order). */
47     uint32_t nw_src_mask;       /* 1-bit in each significant nw_src bit. */
48     uint32_t nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
49 };
50
51 struct sw_flow {
52     struct sw_flow_key key;
53
54     uint16_t priority;          /* Only used on entries with wildcards. */
55     uint16_t idle_timeout;      /* Idle time before discarding (seconds). */
56     uint16_t hard_timeout;      /* Hard expiration time (seconds) */
57     time_t used;                /* Last used time. */
58     time_t created;             /* When the flow was created. */
59     uint64_t packet_count;      /* Number of packets seen. */
60     uint64_t byte_count;        /* Number of bytes seen. */
61     uint8_t reason;             /* Reason flow expired (one of OFPER_*). */
62
63     /* Private to table implementations. */
64     struct list node;
65     struct list iter_node;
66     unsigned long int serial;
67
68     /* Actions (XXX probably most flows have only a single action). */
69     unsigned int n_actions;
70     struct ofp_action *actions;
71 };
72
73 int flow_matches_1wild(const struct sw_flow_key *, const struct sw_flow_key *);
74 int flow_matches_2wild(const struct sw_flow_key *, const struct sw_flow_key *);
75 int flow_del_matches(const struct sw_flow_key *, const struct sw_flow_key *, 
76                      int);
77 struct sw_flow *flow_alloc(int n_actions);
78 void flow_free(struct sw_flow *);
79 void flow_deferred_free(struct sw_flow *);
80 void flow_extract_match(struct sw_flow_key* to, const struct ofp_match* from);
81 void flow_fill_match(struct ofp_match* to, const struct sw_flow_key* from);
82
83 void print_flow(const struct sw_flow_key *);
84 bool flow_timeout(struct sw_flow *flow);
85 void flow_used(struct sw_flow *flow, struct buffer *buffer);
86
87 #endif /* switch-flow.h */