2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
27 struct ofp_action_header;
29 /* OpenFlow protocol utility functions. */
30 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
31 void *make_openflow_xid(size_t openflow_len, uint8_t type,
32 uint32_t xid, struct ofpbuf **);
33 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
34 void *put_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
36 void update_openflow_length(struct ofpbuf *);
37 struct ofpbuf *make_flow_mod(uint16_t command, const struct flow *,
39 struct ofpbuf *make_add_flow(const struct flow *, uint32_t buffer_id,
40 uint16_t max_idle, size_t actions_len);
41 struct ofpbuf *make_del_flow(const struct flow *);
42 struct ofpbuf *make_add_simple_flow(const struct flow *,
43 uint32_t buffer_id, uint16_t out_port,
45 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
47 const struct ofpbuf *payload, int max_send_len);
48 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
50 const struct ofp_action_header *,
52 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
53 uint16_t in_port, uint16_t out_port);
54 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
55 uint16_t in_port, uint16_t out_port);
56 struct ofpbuf *make_echo_request(void);
57 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
58 int check_ofp_message(const struct ofp_header *, uint8_t type, size_t size);
59 int check_ofp_message_array(const struct ofp_header *, uint8_t type,
60 size_t size, size_t array_elt_size,
61 size_t *n_array_elts);
62 int check_ofp_packet_out(const struct ofp_header *, struct ofpbuf *data,
63 int *n_actions, int max_ports);
65 struct flow_stats_iterator {
66 const uint8_t *pos, *end;
68 const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *,
69 const struct ofp_stats_reply *);
70 const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *);
72 struct actions_iterator {
73 const union ofp_action *pos, *end;
75 const union ofp_action *actions_first(struct actions_iterator *,
76 const union ofp_action *,
78 const union ofp_action *actions_next(struct actions_iterator *);
79 int validate_actions(const union ofp_action *, size_t n_actions,
81 bool action_outputs_to_port(const union ofp_action *, uint16_t port);
83 void normalize_match(struct ofp_match *);
84 char *ofp_match_to_literal_string(const struct ofp_match *match);
88 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
89 * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
90 * are only used internally in Open vSwitch and never appear on the wire, so
91 * particular codes used are not important.
94 /* Vendor error numbers currently used in Open vSwitch. */
95 #define OFPUTIL_VENDORS \
96 /* vendor name vendor value */ \
97 OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
98 OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, 0x00002320)
100 /* OFPUTIL_VENDOR_* definitions. */
101 enum ofputil_vendor_codes {
102 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
105 #undef OFPUTIL_VENDOR
110 * We embed system errno values and OpenFlow standard and vendor extension
111 * error codes into a single 31-bit space using the following encoding.
112 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
115 * +------------------------------------------------------+
117 * +------------------------------------------------------+
120 * +--+---------------------------------------------------+
121 * | 0| errno value | errno value
122 * +--+---------------------------------------------------+
124 * 30 29 26 25 16 15 0
125 * +--+-------+----------------+--------------------------+
126 * | 1| 0 | type | code | standard OpenFlow
127 * +--+-------+----------------+--------------------------+ error
129 * 30 29 26 25 16 15 0
130 * +--+-------+----------------+--------------------------+ Nicira
131 * | 1| vendor| type | code | NXET_VENDOR
132 * +--+-------+----------------+--------------------------+ error extension
134 * C and POSIX say that errno values are positive. We assume that they are
135 * less than 2**29. They are actually less than 65536 on at least Linux,
136 * FreeBSD, OpenBSD, and Windows.
138 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
139 * It must be nonzero.
141 * Negative values are not defined.
144 /* Currently 4 bits are allocated to the "vendor" field. Make sure that all
145 * the vendor codes can fit. */
146 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
148 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
151 ofp_mkerr(uint16_t type, uint16_t code)
153 return (1 << 30) | (type << 16) | code;
156 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
157 * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
159 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
161 assert(vendor < OFPUTIL_N_VENDORS);
162 return (1 << 30) | (vendor << 26) | (type << 16) | code;
165 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
166 * 'type' and 'code', as an integer. */
168 ofp_mkerr_nicira(uint16_t type, uint16_t code)
170 return ofp_mkerr_vendor(OFPUTIL_VENDOR_NICIRA, type, code);
173 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
174 * error codes as documented above. */
176 is_ofp_error(int error)
178 return (error & (1 << 30)) != 0;
181 /* Returns true if 'error' appears to be a system errno value. */
185 return !is_ofp_error(error);
188 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
189 * in the format explained above). This is normally one of the
190 * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
191 * standard OpenFlow error. */
192 static inline uint8_t
193 get_ofp_err_vendor(int error)
195 return (error >> 26) & 0xf;
198 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
199 * the format explained above). */
200 static inline uint16_t
201 get_ofp_err_type(int error)
203 return (error >> 16) & 0x3ff;
206 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
207 * the format explained above). */
208 static inline uint16_t
209 get_ofp_err_code(int error)
211 return error & 0xffff;
214 struct ofpbuf *make_ofp_error_msg(int error, const struct ofp_header *);
216 #endif /* ofp-util.h */