ovs-brcompatd: Simplify code in brc_recv_update().
[openvswitch] / lib / odp-util.h
1 /*
2  * Copyright (c) 2009, 2010, 2011 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 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 "hash.h"
25 #include "openflow/openflow.h"
26 #include "openvswitch/datapath-protocol.h"
27 #include "util.h"
28
29 struct ds;
30 struct flow;
31 struct ofpbuf;
32
33 #define ODPP_NONE ((uint16_t) -1)
34
35 static inline uint16_t
36 ofp_port_to_odp_port(uint16_t ofp_port)
37 {
38     switch (ofp_port) {
39     case OFPP_LOCAL:
40         return ODPP_LOCAL;
41     case OFPP_NONE:
42         return ODPP_NONE;
43     default:
44         return ofp_port;
45     }
46 }
47
48 static inline uint16_t
49 odp_port_to_ofp_port(uint16_t odp_port)
50 {
51     switch (odp_port) {
52     case ODPP_LOCAL:
53         return OFPP_LOCAL;
54     case ODPP_NONE:
55         return OFPP_NONE;
56     default:
57         return odp_port;
58     }
59 }
60
61 int odp_action_len(uint16_t type);
62 void format_odp_action(struct ds *, const struct nlattr *);
63 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
64                         size_t actions_len);
65
66 /* Upper bound on the length of a nlattr-formatted flow key.  The longest
67  * nlattr-formatted flow key would be:
68  *
69  *                         struct  pad  nl hdr  total
70  *                         ------  ---  ------  -----
71  *  ODP_KEY_ATTR_TUN_ID        8    --     4     12
72  *  ODP_KEY_ATTR_IN_PORT       4    --     4      8
73  *  ODP_KEY_ATTR_ETHERNET     12    --     4     16
74  *  ODP_KEY_ATTR_8021Q         4    --     4      8
75  *  ODP_KEY_ATTR_ETHERTYPE     2     2     4      8
76  *  ODP_KEY_ATTR_IPV6         34     2     4     40
77  *  ODP_KEY_ATTR_ICMPV6        2     2     4      8
78  *  ODP_KEY_ATTR_ND           28    --     4     32
79  *  -------------------------------------------------
80  *  total                                       132
81  */
82 #define ODPUTIL_FLOW_KEY_BYTES 132
83
84 /* This is an imperfect sanity-check that ODPUTIL_FLOW_KEY_BYTES doesn't
85  * need to be updated, but will at least raise awareness when new ODP
86  * key types are added. */
87 BUILD_ASSERT_DECL(__ODP_KEY_ATTR_MAX == 14);
88
89 /* We allocate temporary on-stack buffers for flow keys as arrays of uint32_t
90  * to ensure proper 32-bit alignment for Netlink attributes.  (An array of
91  * "struct nlattr" might not, in theory, be sufficiently aligned because it
92  * only contains 16-bit types.) */
93 #define ODPUTIL_FLOW_KEY_U32S DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)
94
95 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
96
97 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *);
98 int odp_flow_key_to_flow(const struct nlattr *, size_t, struct flow *);
99
100 #endif /* odp-util.h */