Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
[openvswitch] / lib / odp-util.h
1 /*
2  * Copyright (c) 2009 Nicira Networks.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16
17 #ifndef ODP_UTIL_H
18 #define ODP_UTIL_H 1
19
20 #include <stdbool.h>
21 #include <stdint.h>
22 #include "openflow/openflow.h"
23 #include "openvswitch/datapath-protocol.h"
24
25 struct ds;
26
27 /* The kernel datapaths limits actions to those that fit in a single page of
28  * memory, so there is no point in allocating more than that.  */
29 enum { MAX_ODP_ACTIONS = 4096 / sizeof(union odp_action) };
30
31 struct odp_actions {
32     size_t n_actions;
33     union odp_action actions[MAX_ODP_ACTIONS];
34 };
35
36 static inline void
37 odp_actions_init(struct odp_actions *actions)
38 {
39     actions->n_actions = 0;
40 }
41
42 union odp_action *odp_actions_add(struct odp_actions *actions, uint16_t type);
43
44 static inline bool
45 odp_actions_overflow(const struct odp_actions *actions)
46 {
47     return actions->n_actions > MAX_ODP_ACTIONS;
48 }
49
50 static inline uint16_t
51 ofp_port_to_odp_port(uint16_t ofp_port)
52 {
53     switch (ofp_port) {
54     case OFPP_LOCAL:
55         return ODPP_LOCAL;
56     case OFPP_NONE:
57         return ODPP_NONE;
58     default:
59         return ofp_port;
60     }
61 }
62
63 static inline uint16_t
64 odp_port_to_ofp_port(uint16_t odp_port)
65 {
66     switch (odp_port) {
67     case ODPP_LOCAL:
68         return OFPP_LOCAL;
69     case ODPP_NONE:
70         return OFPP_NONE;
71     default:
72         return odp_port;
73     }
74 }
75
76 void format_odp_action(struct ds *, const union odp_action *);
77 void format_odp_actions(struct ds *, const union odp_action *actions,
78                         size_t n_actions);
79 void format_odp_flow_stats(struct ds *, const struct odp_flow_stats *);
80 void format_odp_flow(struct ds *, const struct odp_flow *);
81
82 #endif /* odp-util.h */