connmgr: Move send_len from ofputil_packet_in to ofproto_packet_in.
[sliver-openvswitch.git] / lib / ofp-util.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 OFP_UTIL_H
18 #define OFP_UTIL_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23 #include "classifier.h"
24 #include "compiler.h"
25 #include "flow.h"
26 #include "match.h"
27 #include "netdev.h"
28 #include "openflow/nicira-ext.h"
29 #include "openvswitch/types.h"
30 #include "type-props.h"
31
32 struct ofpbuf;
33 union ofp_action;
34
35 /* Port numbers. */
36 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
37                                     ofp_port_t *ofp10_port);
38 ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
39
40 enum ofperr ofputil_check_output_port(ofp_port_t ofp_port,
41                                       ofp_port_t max_ports);
42 bool ofputil_port_from_string(const char *, ofp_port_t *portp);
43 void ofputil_format_port(ofp_port_t port, struct ds *);
44 void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
45                             size_t bufsize);
46
47 /* Group numbers. */
48 enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
49 bool ofputil_group_from_string(const char *, uint32_t *group_id);
50 void ofputil_format_group(uint32_t group_id, struct ds *);
51 void ofputil_group_to_string(uint32_t group_id,
52                              char namebuf[MAX_GROUP_NAME_LEN + 1],
53                              size_t bufsize);
54
55 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
56  * to and from IP bitmasks. */
57 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
58 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
59
60 /* Protocols.
61  *
62  * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
63  * a bit extra about the flow match format in use.
64  *
65  * These are arranged from most portable to least portable, or alternatively
66  * from least powerful to most powerful.  Protocols earlier on the list are
67  * more likely to be understood for the purpose of making requests, but
68  * protocol later on the list are more likely to accurately describe a flow
69  * within a switch.
70  *
71  * On any given OpenFlow connection, a single protocol is in effect at any
72  * given time.  These values use separate bits only because that makes it easy
73  * to test whether a particular protocol is within a given set of protocols and
74  * to implement set union and intersection.
75  */
76 enum ofputil_protocol {
77     /* OpenFlow 1.0 protocols.
78      *
79      * The "STD" protocols use the standard OpenFlow 1.0 flow format.
80      * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
81      *
82      * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
83      * extension has been enabled.  The other protocols have it disabled.
84      */
85 #define OFPUTIL_P_NONE 0
86     OFPUTIL_P_OF10_STD     = 1 << 0,
87     OFPUTIL_P_OF10_STD_TID = 1 << 1,
88     OFPUTIL_P_OF10_NXM     = 1 << 2,
89     OFPUTIL_P_OF10_NXM_TID = 1 << 3,
90 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
91 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
92
93     /* OpenFlow 1.1 protocol.
94      *
95      * We only support the standard OpenFlow 1.1 flow format.
96      *
97      * OpenFlow 1.1 always operates with an equivalent of the
98      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
99      * variant. */
100     OFPUTIL_P_OF11_STD     = 1 << 4,
101
102     /* OpenFlow 1.2+ protocols (only one variant each).
103      *
104      * These use the standard OpenFlow Extensible Match (OXM) flow format.
105      *
106      * OpenFlow 1.2+ always operates with an equivalent of the
107      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
108      * variant. */
109     OFPUTIL_P_OF12_OXM      = 1 << 5,
110     OFPUTIL_P_OF13_OXM      = 1 << 6,
111 #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_OXM)
112
113 #define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
114                                OFPUTIL_P_ANY_OXM)
115
116 #define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
117
118 #define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
119
120 #define OFPUTIL_P_OF12_UP (OFPUTIL_P_ANY_OXM)
121
122 #define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM)
123
124     /* All protocols. */
125 #define OFPUTIL_P_ANY ((1 << 7) - 1)
126
127     /* Protocols in which a specific table may be specified in flow_mods. */
128 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
129                        OFPUTIL_P_OF10_NXM_TID | \
130                        OFPUTIL_P_OF11_STD |     \
131                        OFPUTIL_P_ANY_OXM)
132 };
133
134 /* Protocols to use for flow dumps, from most to least preferred. */
135 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
136 extern size_t ofputil_n_flow_dump_protocols;
137
138 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
139 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
140 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
141
142 bool ofputil_protocol_is_valid(enum ofputil_protocol);
143 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
144                                                bool enable);
145 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
146 enum ofputil_protocol ofputil_protocol_set_base(
147     enum ofputil_protocol cur, enum ofputil_protocol new_base);
148
149 const char *ofputil_protocol_to_string(enum ofputil_protocol);
150 char *ofputil_protocols_to_string(enum ofputil_protocol);
151 enum ofputil_protocol ofputil_protocols_from_string(const char *);
152
153 void ofputil_format_version(struct ds *, enum ofp_version);
154 void ofputil_format_version_name(struct ds *, enum ofp_version);
155
156 /* A bitmap of version numbers
157  *
158  * Bit offsets correspond to ofp_version numbers which in turn correspond to
159  * wire-protocol numbers for Open Flow versions..  E.g. (1u << OFP11_VERSION)
160  * is the mask for Open Flow 1.1.  If the bit for a version is set then it is
161  * allowed, otherwise it is disallowed. */
162
163 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
164 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
165
166 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
167 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
168
169 /* Bitmap of OpenFlow versions that Open vSwitch supports. */
170 #define OFPUTIL_SUPPORTED_VERSIONS \
171     ((1u << OFP10_VERSION) | (1u << OFP12_VERSION) | (1u << OFP13_VERSION))
172
173 /* Bitmap of OpenFlow versions to enable by default (a subset of
174  * OFPUTIL_SUPPORTED_VERSIONS). */
175 #define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
176
177 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
178
179 const char *ofputil_version_to_string(enum ofp_version ofp_version);
180 uint32_t ofputil_versions_from_string(const char *s);
181 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
182
183 bool ofputil_decode_hello(const struct ofp_header *,
184                           uint32_t *allowed_versions);
185 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
186
187 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
188                                            enum ofputil_protocol want,
189                                            enum ofputil_protocol *next);
190
191 /* nx_flow_format */
192 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
193 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
194 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
195 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
196
197 /* Work with ofp10_match. */
198 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
199 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
200                                     struct match *);
201 void ofputil_normalize_match(struct match *);
202 void ofputil_normalize_match_quiet(struct match *);
203 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
204
205 /* Work with ofp11_match. */
206 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
207                                      uint16_t *padded_match_len);
208 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
209                                            struct match *);
210 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
211                             enum ofputil_protocol);
212 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
213 int ofputil_match_typical_len(enum ofputil_protocol);
214
215 /* dl_type translation between OpenFlow and 'struct flow' format. */
216 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
217 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
218
219 /* PACKET_IN. */
220 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
221 int ofputil_packet_in_format_from_string(const char *);
222 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
223 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
224                                                  enum nx_packet_in_format);
225
226 /* NXT_FLOW_MOD_TABLE_ID extension. */
227 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
228
229 /* Protocol-independent flow_mod flags. */
230 enum ofputil_flow_mod_flags {
231     /* Flags that are maintained with a flow as part of its state.
232      *
233      * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
234     OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
235     OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
236     OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
237 #define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM      \
238                           | OFPUTIL_FF_NO_PKT_COUNTS    \
239                           | OFPUTIL_FF_NO_BYT_COUNTS)
240
241     /* Flags that affect flow_mod behavior but are not part of flow state. */
242     OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
243     OFPUTIL_FF_EMERG         = 1 << 4, /* OpenFlow 1.0 only. */
244     OFPUTIL_FF_RESET_COUNTS  = 1 << 5, /* OpenFlow 1.2+. */
245 };
246
247 /* Protocol-independent flow_mod.
248  *
249  * The handling of cookies across multiple versions of OpenFlow is a bit
250  * confusing.  See DESIGN for the details. */
251 struct ofputil_flow_mod {
252     struct list list_node;    /* For queuing flow_mods. */
253
254     struct match match;
255     unsigned int priority;
256
257     /* Cookie matching.  The flow_mod affects only flows that have cookies that
258      * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
259      *
260      * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
261     ovs_be64 cookie;         /* Cookie bits to match. */
262     ovs_be64 cookie_mask;    /* 1-bit in each 'cookie' bit to match. */
263
264     /* Cookie changes.
265      *
266      * OFPFC_ADD uses 'new_cookie' as the new flow's cookie.  'new_cookie'
267      * should not be UINT64_MAX.
268      *
269      * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
270      *
271      *   - If one or more matching flows exist and 'modify_cookie' is true,
272      *     then the flow_mod changes the existing flows' cookies to
273      *     'new_cookie'.  'new_cookie' should not be UINT64_MAX.
274      *
275      *   - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
276      *     'cookie_mask' is 0, then the flow_mod adds a new flow with
277      *     'new_cookie' as its cookie.
278      */
279     ovs_be64 new_cookie;     /* New cookie to install or UINT64_MAX. */
280     bool modify_cookie;      /* Set cookie of existing flow to 'new_cookie'? */
281
282     uint8_t table_id;
283     uint16_t command;
284     uint16_t idle_timeout;
285     uint16_t hard_timeout;
286     uint32_t buffer_id;
287     ofp_port_t out_port;
288     uint32_t out_group;
289     enum ofputil_flow_mod_flags flags;
290     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
291     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
292 };
293
294 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
295                                     const struct ofp_header *,
296                                     enum ofputil_protocol,
297                                     struct ofpbuf *ofpacts);
298 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
299                                        enum ofputil_protocol);
300
301 /* Flow stats or aggregate stats request, independent of protocol. */
302 struct ofputil_flow_stats_request {
303     bool aggregate;             /* Aggregate results? */
304     struct match match;
305     ovs_be64 cookie;
306     ovs_be64 cookie_mask;
307     ofp_port_t out_port;
308     uint32_t out_group;
309     uint8_t table_id;
310 };
311
312 enum ofperr ofputil_decode_flow_stats_request(
313     struct ofputil_flow_stats_request *, const struct ofp_header *);
314 struct ofpbuf *ofputil_encode_flow_stats_request(
315     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
316
317 /* Flow stats reply, independent of protocol. */
318 struct ofputil_flow_stats {
319     struct match match;
320     ovs_be64 cookie;
321     uint8_t table_id;
322     uint32_t duration_sec;
323     uint32_t duration_nsec;
324     uint16_t priority;
325     uint16_t idle_timeout;
326     uint16_t hard_timeout;
327     int idle_age;               /* Seconds since last packet, -1 if unknown. */
328     int hard_age;               /* Seconds since last change, -1 if unknown. */
329     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
330     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
331     struct ofpact *ofpacts;
332     size_t ofpacts_len;
333     enum ofputil_flow_mod_flags flags;
334 };
335
336 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
337                                     struct ofpbuf *msg,
338                                     bool flow_age_extension,
339                                     struct ofpbuf *ofpacts);
340 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
341                                      struct list *replies);
342
343 /* Aggregate stats reply, independent of protocol. */
344 struct ofputil_aggregate_stats {
345     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
346     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
347     uint32_t flow_count;
348 };
349
350 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
351     const struct ofputil_aggregate_stats *stats,
352     const struct ofp_header *request);
353 enum ofperr ofputil_decode_aggregate_stats_reply(
354     struct ofputil_aggregate_stats *,
355     const struct ofp_header *reply);
356
357 /* Flow removed message, independent of protocol. */
358 struct ofputil_flow_removed {
359     struct match match;
360     uint16_t priority;
361     ovs_be64 cookie;
362     uint8_t reason;             /* One of OFPRR_*. */
363     uint8_t table_id;           /* 255 if message didn't include table ID. */
364     uint32_t duration_sec;
365     uint32_t duration_nsec;
366     uint16_t idle_timeout;
367     uint16_t hard_timeout;
368     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
369     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
370 };
371
372 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
373                                         const struct ofp_header *);
374 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
375                                            enum ofputil_protocol);
376
377 /* Abstract packet-in message. */
378 struct ofputil_packet_in {
379     const void *packet;
380     size_t packet_len;
381
382     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
383     uint8_t table_id;
384     ovs_be64 cookie;
385
386     uint32_t buffer_id;
387     uint16_t total_len;         /* Full length of frame. */
388
389     struct flow_metadata fmd;   /* Metadata at creation time. */
390 };
391
392 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
393                                      const struct ofp_header *);
394 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
395                                         enum ofputil_protocol protocol,
396                                         enum nx_packet_in_format);
397
398 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
399 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
400                                                char *reasonbuf,
401                                                size_t bufsize);
402 bool ofputil_packet_in_reason_from_string(const char *,
403                                           enum ofp_packet_in_reason *);
404
405 /* Abstract packet-out message.
406  *
407  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
408  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
409 struct ofputil_packet_out {
410     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
411     size_t packet_len;          /* Length of packet data in bytes. */
412     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
413     ofp_port_t in_port;         /* Packet's input port. */
414     struct ofpact *ofpacts;     /* Actions. */
415     size_t ofpacts_len;         /* Size of ofpacts in bytes. */
416 };
417
418 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
419                                       const struct ofp_header *,
420                                       struct ofpbuf *ofpacts);
421 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
422                                          enum ofputil_protocol protocol);
423
424 enum ofputil_port_config {
425     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
426     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
427     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
428     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
429     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
430     /* OpenFlow 1.0 only. */
431     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
432     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
433     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
434     /* There are no OpenFlow 1.1-only bits. */
435 };
436
437 enum ofputil_port_state {
438     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
439     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
440     /* OpenFlow 1.1 only. */
441     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
442     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
443     /* OpenFlow 1.0 only. */
444     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
445     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
446     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
447     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
448     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
449 };
450
451 /* Abstract ofp10_phy_port or ofp11_port. */
452 struct ofputil_phy_port {
453     ofp_port_t port_no;
454     uint8_t hw_addr[OFP_ETH_ALEN];
455     char name[OFP_MAX_PORT_NAME_LEN];
456     enum ofputil_port_config config;
457     enum ofputil_port_state state;
458
459     /* NETDEV_F_* feature bitmasks. */
460     enum netdev_features curr;       /* Current features. */
461     enum netdev_features advertised; /* Features advertised by the port. */
462     enum netdev_features supported;  /* Features supported by the port. */
463     enum netdev_features peer;       /* Features advertised by peer. */
464
465     /* Speed. */
466     uint32_t curr_speed;        /* Current speed, in kbps. */
467     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
468 };
469
470 enum ofputil_capabilities {
471     /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
472     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
473     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
474     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
475     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
476     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
477
478     /* OpenFlow 1.0 and 1.1 share this capability. */
479     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
480
481     /* OpenFlow 1.0 only. */
482     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
483
484     /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
485     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
486
487     /* OpenFlow 1.2 and 1.3 share this capability */
488     OFPUTIL_C_PORT_BLOCKED   = 1 << 8,  /* Switch will block looping ports */
489 };
490
491 enum ofputil_action_bitmap {
492     OFPUTIL_A_OUTPUT         = 1 << 0,
493     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
494     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
495     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
496     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
497     OFPUTIL_A_SET_DL_DST     = 1 << 5,
498     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
499     OFPUTIL_A_SET_NW_DST     = 1 << 7,
500     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
501     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
502     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
503     OFPUTIL_A_SET_TP_DST     = 1 << 11,
504     OFPUTIL_A_ENQUEUE        = 1 << 12,
505     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
506     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
507     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
508     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
509     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
510     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
511     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
512     OFPUTIL_A_POP_VLAN       = 1 << 20,
513     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
514     OFPUTIL_A_POP_MPLS       = 1 << 22,
515     OFPUTIL_A_SET_QUEUE      = 1 << 23,
516     OFPUTIL_A_GROUP          = 1 << 24,
517     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
518     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
519     OFPUTIL_A_SET_FIELD      = 1 << 27,
520 };
521
522 /* Abstract ofp_switch_features. */
523 struct ofputil_switch_features {
524     uint64_t datapath_id;       /* Datapath unique ID. */
525     uint32_t n_buffers;         /* Max packets buffered at once. */
526     uint8_t n_tables;           /* Number of tables supported by datapath. */
527     uint8_t auxiliary_id;       /* Identify auxiliary connections */
528     enum ofputil_capabilities capabilities;
529     enum ofputil_action_bitmap actions;
530 };
531
532 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
533                                            struct ofputil_switch_features *,
534                                            struct ofpbuf *);
535
536 struct ofpbuf *ofputil_encode_switch_features(
537     const struct ofputil_switch_features *, enum ofputil_protocol,
538     ovs_be32 xid);
539 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
540                                       struct ofpbuf *);
541 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
542
543 /* phy_port helper functions. */
544 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
545                           struct ofputil_phy_port *);
546 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
547
548 /* Abstract ofp_port_status. */
549 struct ofputil_port_status {
550     enum ofp_port_reason reason;
551     struct ofputil_phy_port desc;
552 };
553
554 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
555                                        struct ofputil_port_status *);
556 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
557                                           enum ofputil_protocol);
558
559 /* Abstract ofp_port_mod. */
560 struct ofputil_port_mod {
561     ofp_port_t port_no;
562     uint8_t hw_addr[OFP_ETH_ALEN];
563     enum ofputil_port_config config;
564     enum ofputil_port_config mask;
565     enum netdev_features advertise;
566 };
567
568 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
569                                     struct ofputil_port_mod *);
570 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
571                                        enum ofputil_protocol);
572
573 /* Abstract ofp_table_mod. */
574 struct ofputil_table_mod {
575     uint8_t table_id;         /* ID of the table, 0xff indicates all tables. */
576     uint32_t config;
577 };
578
579 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
580                                     struct ofputil_table_mod *);
581 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
582                                        enum ofputil_protocol);
583
584 /* Meter band configuration for all supported band types. */
585 struct ofputil_meter_band {
586     uint16_t type;
587     uint8_t prec_level;         /* Non-zero if type == OFPMBT_DSCP_REMARK. */
588     uint32_t rate;
589     uint32_t burst_size;
590 };
591
592 struct ofputil_meter_band_stats {
593     uint64_t packet_count;
594     uint64_t byte_count;
595 };
596
597 struct ofputil_meter_config {
598     uint32_t meter_id;
599     uint16_t flags;
600     uint16_t n_bands;
601     struct ofputil_meter_band *bands;
602 };
603
604 /* Abstract ofp_meter_mod. */
605 struct ofputil_meter_mod {
606     uint16_t command;
607     struct ofputil_meter_config meter;
608 };
609
610 struct ofputil_meter_stats {
611     uint32_t meter_id;
612     uint32_t flow_count;
613     uint64_t packet_in_count;
614     uint64_t byte_in_count;
615     uint32_t duration_sec;
616     uint32_t duration_nsec;
617     uint16_t n_bands;
618     struct ofputil_meter_band_stats *bands;
619 };
620
621 struct ofputil_meter_features {
622     uint32_t max_meters;        /* Maximum number of meters. */
623     uint32_t band_types;        /* Can support max 32 band types. */
624     uint32_t capabilities;      /* Supported flags. */
625     uint8_t  max_bands;
626     uint8_t  max_color;
627 };
628
629 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
630                                      struct ofputil_meter_mod *,
631                                      struct ofpbuf *bands);
632 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
633                                         const struct ofputil_meter_mod *);
634
635 void ofputil_decode_meter_features(const struct ofp_header *,
636                                    struct ofputil_meter_features *);
637 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
638                                                    ofputil_meter_features *,
639                                                    const struct ofp_header *
640                                                    request);
641 void ofputil_decode_meter_request(const struct ofp_header *,
642                                   uint32_t *meter_id);
643
644 void ofputil_append_meter_config(struct list *replies,
645                                  const struct ofputil_meter_config *);
646
647 void ofputil_append_meter_stats(struct list *replies,
648                                 const struct ofputil_meter_stats *);
649
650 enum ofputil_meter_request_type {
651     OFPUTIL_METER_FEATURES,
652     OFPUTIL_METER_CONFIG,
653     OFPUTIL_METER_STATS
654 };
655
656 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
657                                             enum ofputil_meter_request_type,
658                                             uint32_t meter_id);
659
660 int ofputil_decode_meter_stats(struct ofpbuf *,
661                                struct ofputil_meter_stats *,
662                                struct ofpbuf *bands);
663
664 int ofputil_decode_meter_config(struct ofpbuf *,
665                                 struct ofputil_meter_config *,
666                                 struct ofpbuf *bands);
667
668 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
669 typedef struct { uint32_t uint32; } ofproto_meter_id;
670
671 /* Abstract ofp_role_request and reply. */
672 struct ofputil_role_request {
673     enum ofp12_controller_role role;
674     bool have_generation_id;
675     uint64_t generation_id;
676 };
677
678 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
679                                         struct ofputil_role_request *);
680 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
681                                          const struct ofputil_role_request *);
682
683 /* Abstract table stats.
684  *
685  * For now we use ofp12_table_stats as a superset of the other protocol
686  * versions' table stats. */
687
688 struct ofpbuf *ofputil_encode_table_stats_reply(
689     const struct ofp12_table_stats[], int n,
690     const struct ofp_header *request);
691
692 /* Abstract nx_flow_monitor_request. */
693 struct ofputil_flow_monitor_request {
694     uint32_t id;
695     enum nx_flow_monitor_flags flags;
696     ofp_port_t out_port;
697     uint8_t table_id;
698     struct match match;
699 };
700
701 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
702                                         struct ofpbuf *msg);
703 void ofputil_append_flow_monitor_request(
704     const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
705
706 /* Abstract nx_flow_update. */
707 struct ofputil_flow_update {
708     enum nx_flow_update_event event;
709
710     /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
711     enum ofp_flow_removed_reason reason;
712     uint16_t idle_timeout;
713     uint16_t hard_timeout;
714     uint8_t table_id;
715     ovs_be64 cookie;
716     struct match *match;
717     uint16_t priority;
718     struct ofpact *ofpacts;
719     size_t ofpacts_len;
720
721     /* Used only for NXFME_ABBREV. */
722     ovs_be32 xid;
723 };
724
725 int ofputil_decode_flow_update(struct ofputil_flow_update *,
726                                struct ofpbuf *msg, struct ofpbuf *ofpacts);
727 void ofputil_start_flow_update(struct list *replies);
728 void ofputil_append_flow_update(const struct ofputil_flow_update *,
729                                 struct list *replies);
730
731 /* Abstract nx_flow_monitor_cancel. */
732 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
733 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
734
735 /* Encoding OpenFlow stats messages. */
736 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
737                                           const struct ofputil_phy_port *pp,
738                                           struct list *replies);
739
740 /* Encoding simple OpenFlow messages. */
741 struct ofpbuf *make_echo_request(enum ofp_version);
742 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
743
744 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
745
746 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
747 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
748
749 \f
750 /* Actions. */
751
752 /* The type of an action.
753  *
754  * For each implemented OFPAT10_* and NXAST_* action type, there is a
755  * corresponding constant prefixed with OFPUTIL_, e.g.:
756  *
757  * OFPUTIL_OFPAT10_OUTPUT
758  * OFPUTIL_OFPAT10_SET_VLAN_VID
759  * OFPUTIL_OFPAT10_SET_VLAN_PCP
760  * OFPUTIL_OFPAT10_STRIP_VLAN
761  * OFPUTIL_OFPAT10_SET_DL_SRC
762  * OFPUTIL_OFPAT10_SET_DL_DST
763  * OFPUTIL_OFPAT10_SET_NW_SRC
764  * OFPUTIL_OFPAT10_SET_NW_DST
765  * OFPUTIL_OFPAT10_SET_NW_TOS
766  * OFPUTIL_OFPAT10_SET_TP_SRC
767  * OFPUTIL_OFPAT10_SET_TP_DST
768  * OFPUTIL_OFPAT10_ENQUEUE
769  * OFPUTIL_NXAST_RESUBMIT
770  * OFPUTIL_NXAST_SET_TUNNEL
771  * OFPUTIL_NXAST_SET_METADATA
772  * OFPUTIL_NXAST_SET_QUEUE
773  * OFPUTIL_NXAST_POP_QUEUE
774  * OFPUTIL_NXAST_REG_MOVE
775  * OFPUTIL_NXAST_REG_LOAD
776  * OFPUTIL_NXAST_NOTE
777  * OFPUTIL_NXAST_SET_TUNNEL64
778  * OFPUTIL_NXAST_MULTIPATH
779  * OFPUTIL_NXAST_BUNDLE
780  * OFPUTIL_NXAST_BUNDLE_LOAD
781  * OFPUTIL_NXAST_RESUBMIT_TABLE
782  * OFPUTIL_NXAST_OUTPUT_REG
783  * OFPUTIL_NXAST_LEARN
784  * OFPUTIL_NXAST_DEC_TTL
785  * OFPUTIL_NXAST_FIN_TIMEOUT
786  *
787  * (The above list helps developers who want to "grep" for these definitions.)
788  */
789 enum OVS_PACKED_ENUM ofputil_action_code {
790     OFPUTIL_ACTION_INVALID,
791 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
792 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
793 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   OFPUTIL_##ENUM,
794 #include "ofp-util.def"
795 };
796
797 /* The number of values of "enum ofputil_action_code". */
798 enum {
799 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
800 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
801 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   + 1
802     OFPUTIL_N_ACTIONS = 1
803 #include "ofp-util.def"
804 };
805
806 int ofputil_action_code_from_name(const char *);
807
808 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
809
810 /* For each OpenFlow action <ENUM> that has a corresponding action structure
811  * struct <STRUCT>, this defines two functions:
812  *
813  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
814  *
815  *     Initializes the parts of 'action' that identify it as having type <ENUM>
816  *     and length 'sizeof *action' and zeros the rest.  For actions that have
817  *     variable length, the length used and cleared is that of struct <STRUCT>.
818  *
819  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
820  *
821  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
822  *     initializes it with ofputil_init_<ENUM>(), and returns it.
823  */
824 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
825     void ofputil_init_##ENUM(struct STRUCT *);          \
826     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
827 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
828     void ofputil_init_##ENUM(struct STRUCT *);          \
829     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
830 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
831     void ofputil_init_##ENUM(struct STRUCT *);          \
832     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
833 #include "ofp-util.def"
834
835 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
836
837 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
838
839 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
840                                  union ofp_action **, size_t *);
841
842 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
843                            const union ofp_action *b, size_t n_b);
844 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
845
846 /* Handy utility for parsing flows and actions. */
847 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
848
849 struct ofputil_port_stats {
850     ofp_port_t port_no;
851     struct netdev_stats stats;
852     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
853     uint32_t duration_nsec;
854 };
855
856 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
857                                                  ofp_port_t port);
858 void ofputil_append_port_stat(struct list *replies,
859                               const struct ofputil_port_stats *ops);
860 size_t ofputil_count_port_stats(const struct ofp_header *);
861 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
862 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
863                                               ofp_port_t *ofp10_port);
864
865 struct ofputil_queue_stats_request {
866     ofp_port_t port_no;           /* OFPP_ANY means "all ports". */
867     uint32_t queue_id;
868 };
869
870 enum ofperr
871 ofputil_decode_queue_stats_request(const struct ofp_header *request,
872                                    struct ofputil_queue_stats_request *oqsr);
873 struct ofpbuf *
874 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
875                                    const struct ofputil_queue_stats_request *oqsr);
876
877 struct ofputil_queue_stats {
878     ofp_port_t port_no;
879     uint32_t queue_id;
880
881     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
882     uint64_t tx_bytes;
883     uint64_t tx_packets;
884     uint64_t tx_errors;
885
886     /* UINT32_MAX if unknown. */
887     uint32_t duration_sec;
888     uint32_t duration_nsec;
889 };
890
891 size_t ofputil_count_queue_stats(const struct ofp_header *);
892 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
893 void ofputil_append_queue_stat(struct list *replies,
894                                const struct ofputil_queue_stats *oqs);
895
896 /* Bucket for use in groups. */
897 struct ofputil_bucket {
898     struct list list_node;
899     uint16_t weight;            /* Relative weight, for "select" groups. */
900     ofp_port_t watch_port;      /* Port whose state affects whether this bucket
901                                  * is live. Only required for fast failover
902                                  * groups. */
903     uint32_t watch_group;       /* Group whose state affects whether this
904                                  * bucket is live. Only required for fast
905                                  * failover groups. */
906     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
907     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
908 };
909
910 /* Protocol-independent group_mod. */
911 struct ofputil_group_mod {
912     uint16_t command;             /* One of OFPGC11_*. */
913     uint8_t type;                 /* One of OFPGT11_*. */
914     uint32_t group_id;            /* Group identifier. */
915     struct list buckets;          /* Contains "struct ofputil_bucket"s. */
916 };
917
918 struct bucket_counter {
919     uint64_t packet_count;   /* Number of packets processed by bucket. */
920     uint64_t byte_count;     /* Number of bytes processed by bucket. */
921 };
922
923 /* Group stats reply, independent of protocol. */
924 struct ofputil_group_stats {
925     uint32_t group_id;    /* Group identifier. */
926     uint32_t ref_count;
927     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
928     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
929     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
930     uint32_t duration_nsec;
931     uint32_t n_buckets;
932     struct bucket_counter *bucket_stats;
933 };
934
935 /* Group features reply, independent of protocol. */
936 struct ofputil_group_features {
937     uint32_t  types;           /* Bitmap of OFPGT_* values supported. */
938     uint32_t  capabilities;    /* Bitmap of OFPGFC12_* capability supported. */
939     uint32_t  max_groups[4];   /* Maximum number of groups for each type. */
940     uint32_t  actions[4];      /* Bitmaps of OFPAT_* that are supported. */
941 };
942
943 /* Group desc reply, independent of protocol. */
944 struct ofputil_group_desc {
945     uint8_t type;               /* One of OFPGT_*. */
946     uint32_t group_id;          /* Group identifier. */
947     struct list buckets;        /* Contains "struct ofputil_bucket"s. */
948 };
949
950 void ofputil_bucket_list_destroy(struct list *buckets);
951
952 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
953                                                   uint32_t group_id);
954 enum ofperr ofputil_decode_group_stats_request(
955     const struct ofp_header *request, uint32_t *group_id);
956 void ofputil_append_group_stats(struct list *replies,
957                                 const struct ofputil_group_stats *);
958 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
959 struct ofpbuf *ofputil_encode_group_features_reply(
960     const struct ofputil_group_features *, const struct ofp_header *request);
961 void ofputil_decode_group_features_reply(const struct ofp_header *,
962                                          struct ofputil_group_features *);
963 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
964                                         const struct ofputil_group_mod *gm);
965
966 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
967                                      struct ofputil_group_mod *);
968
969 int ofputil_decode_group_stats_reply(struct ofpbuf *,
970                                      struct ofputil_group_stats *);
971
972 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
973                                     struct ofpbuf *, enum ofp_version);
974
975 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
976                                      struct list *buckets,
977                                      struct list *replies);
978 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version);
979
980 #endif /* ofp-util.h */