debian: Synchronize debian/changelog with downstream Debian changelog.
[openvswitch] / lib / odp-util.h
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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 ODP_UTIL_H
18 #define ODP_UTIL_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23 #include <string.h>
24 #include <linux/openvswitch.h>
25 #include "hash.h"
26 #include "openflow/openflow.h"
27 #include "util.h"
28
29 struct ds;
30 struct flow;
31 struct nlattr;
32 struct ofpbuf;
33 struct shash;
34
35 #define OVSP_NONE ((uint16_t) -1)
36
37 static inline uint16_t
38 ofp_port_to_odp_port(uint16_t ofp_port)
39 {
40     switch (ofp_port) {
41     case OFPP_LOCAL:
42         return OVSP_LOCAL;
43     case OFPP_NONE:
44         return OVSP_NONE;
45     default:
46         return ofp_port;
47     }
48 }
49
50 static inline uint16_t
51 odp_port_to_ofp_port(uint16_t odp_port)
52 {
53     switch (odp_port) {
54     case OVSP_LOCAL:
55         return OFPP_LOCAL;
56     case OVSP_NONE:
57         return OFPP_NONE;
58     default:
59         return odp_port;
60     }
61 }
62
63 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
64                         size_t actions_len);
65 int odp_actions_from_string(const char *, const struct shash *port_names,
66                             struct ofpbuf *odp_actions);
67
68 /* Upper bound on the length of a nlattr-formatted flow key.  The longest
69  * nlattr-formatted flow key would be:
70  *
71  *                         struct  pad  nl hdr  total
72  *                         ------  ---  ------  -----
73  *  OVS_KEY_ATTR_PRIORITY      4    --     4      8
74  *  OVS_KEY_ATTR_TUN_ID        8    --     4     12
75  *  OVS_KEY_ATTR_IN_PORT       4    --     4      8
76  *  OVS_KEY_ATTR_ETHERNET     12    --     4     16
77  *  OVS_KEY_ATTR_8021Q         4    --     4      8
78  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8
79  *  OVS_KEY_ATTR_IPV6         40    --     4     44
80  *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
81  *  OVS_KEY_ATTR_ND           28    --     4     32
82  *  -------------------------------------------------
83  *  total                                       144
84  */
85 #define ODPUTIL_FLOW_KEY_BYTES 144
86
87 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
88  * key.  An array of "struct nlattr" might not, in theory, be sufficiently
89  * aligned because it only contains 16-bit types. */
90 struct odputil_keybuf {
91     uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
92 };
93
94 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
95 int odp_flow_key_from_string(const char *s, const struct shash *port_names,
96                              struct ofpbuf *);
97
98 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *);
99
100 uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
101
102 /* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
103  * attributes) matches OVS userspace expectations.
104  *
105  * These values are arranged so that greater values are "more important" than
106  * lesser ones.  In particular, a single flow key can fit the descriptions for
107  * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH.  Such a key is treated as
108  * ODP_FIT_TOO_LITTLE. */
109 enum odp_key_fitness {
110     ODP_FIT_PERFECT,            /* The key had exactly the fields we expect. */
111     ODP_FIT_TOO_MUCH,           /* The key had fields we don't understand. */
112     ODP_FIT_TOO_LITTLE,         /* The key lacked fields we expected to see. */
113     ODP_FIT_ERROR,              /* The key was invalid. */
114 };
115 enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
116                                           struct flow *);
117 const char *odp_key_fitness_to_string(enum odp_key_fitness);
118
119 enum user_action_cookie_type {
120     USER_ACTION_COOKIE_UNSPEC,
121     USER_ACTION_COOKIE_SFLOW,        /* Packet for sFlow sampling. */
122 };
123
124 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
125  * Since is it passed to kernel as u64, its size has to be 8 bytes. */
126 struct user_action_cookie {
127     uint8_t   type;                 /* enum user_action_cookie_type. */
128     uint8_t   n_output;             /* No of output ports. used by sflow. */
129     ovs_be16  vlan_tci;             /* Used by sFlow */
130     uint32_t  data;                 /* Data is len for OFPP_CONTROLLER action.
131                                        For sFlow it is port_ifindex. */
132 };
133
134 BUILD_ASSERT_DECL(sizeof(struct user_action_cookie) == 8);
135
136 size_t odp_put_userspace_action(uint32_t pid,
137                                 const struct user_action_cookie *,
138                                 struct ofpbuf *odp_actions);
139
140 void commit_odp_actions(const struct flow *, struct flow *base,
141                         struct ofpbuf *odp_actions);
142 #endif /* odp-util.h */