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     uint16_t controller_id;              /* Controller ID to send to. */
 384     uint8_t table_id;
 385     ovs_be64 cookie;
 386
 387     uint32_t buffer_id;
 388     int send_len;
 389     uint16_t total_len;         /* Full length of frame. */
 390
 391     struct flow_metadata fmd;   /* Metadata at creation time. */
 392 };
 393
 394 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
 395                                      const struct ofp_header *);
 396 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 397                                         enum ofputil_protocol protocol,
 398                                         enum nx_packet_in_format);
 399
 400 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
 401 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
 402                                                char *reasonbuf,
 403                                                size_t bufsize);
 404 bool ofputil_packet_in_reason_from_string(const char *,
 405                                           enum ofp_packet_in_reason *);
 406
 407 /* Abstract packet-out message.
 408  *
 409  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
 410  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
 411 struct ofputil_packet_out {
 412     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 413     size_t packet_len;          /* Length of packet data in bytes. */
 414     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 415     ofp_port_t in_port;         /* Packet's input port. */
 416     struct ofpact *ofpacts;     /* Actions. */
 417     size_t ofpacts_len;         /* Size of ofpacts in bytes. */
 418 };
 419
 420 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 421                                       const struct ofp_header *,
 422                                       struct ofpbuf *ofpacts);
 423 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
 424                                          enum ofputil_protocol protocol);
 425
 426 enum ofputil_port_config {
 427     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
 428     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
 429     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
 430     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
 431     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
 432     /* OpenFlow 1.0 only. */
 433     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
 434     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 435     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 436     /* There are no OpenFlow 1.1-only bits. */
 437 };
 438
 439 enum ofputil_port_state {
 440     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
 441     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 442     /* OpenFlow 1.1 only. */
 443     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
 444     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
 445     /* OpenFlow 1.0 only. */
 446     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 447     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 448     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 449     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 450     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 451 };
 452
 453 /* Abstract ofp10_phy_port or ofp11_port. */
 454 struct ofputil_phy_port {
 455     ofp_port_t port_no;
 456     uint8_t hw_addr[OFP_ETH_ALEN];
 457     char name[OFP_MAX_PORT_NAME_LEN];
 458     enum ofputil_port_config config;
 459     enum ofputil_port_state state;
 460
 461     /* NETDEV_F_* feature bitmasks. */
 462     enum netdev_features curr;       /* Current features. */
 463     enum netdev_features advertised; /* Features advertised by the port. */
 464     enum netdev_features supported;  /* Features supported by the port. */
 465     enum netdev_features peer;       /* Features advertised by peer. */
 466
 467     /* Speed. */
 468     uint32_t curr_speed;        /* Current speed, in kbps. */
 469     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
 470 };
 471
 472 enum ofputil_capabilities {
 473     /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
 474     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 475     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 476     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
 477     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 478     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 479
 480     /* OpenFlow 1.0 and 1.1 share this capability. */
 481     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
 482
 483     /* OpenFlow 1.0 only. */
 484     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
 485
 486     /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
 487     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
 488
 489     /* OpenFlow 1.2 and 1.3 share this capability */
 490     OFPUTIL_C_PORT_BLOCKED   = 1 << 8,  /* Switch will block looping ports */
 491 };
 492
 493 enum ofputil_action_bitmap {
 494     OFPUTIL_A_OUTPUT         = 1 << 0,
 495     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
 496     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
 497     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
 498     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
 499     OFPUTIL_A_SET_DL_DST     = 1 << 5,
 500     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
 501     OFPUTIL_A_SET_NW_DST     = 1 << 7,
 502     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
 503     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
 504     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
 505     OFPUTIL_A_SET_TP_DST     = 1 << 11,
 506     OFPUTIL_A_ENQUEUE        = 1 << 12,
 507     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
 508     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
 509     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
 510     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
 511     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
 512     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
 513     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
 514     OFPUTIL_A_POP_VLAN       = 1 << 20,
 515     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
 516     OFPUTIL_A_POP_MPLS       = 1 << 22,
 517     OFPUTIL_A_SET_QUEUE      = 1 << 23,
 518     OFPUTIL_A_GROUP          = 1 << 24,
 519     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
 520     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
 521     OFPUTIL_A_SET_FIELD      = 1 << 27,
 522 };
 523
 524 /* Abstract ofp_switch_features. */
 525 struct ofputil_switch_features {
 526     uint64_t datapath_id;       /* Datapath unique ID. */
 527     uint32_t n_buffers;         /* Max packets buffered at once. */
 528     uint8_t n_tables;           /* Number of tables supported by datapath. */
 529     uint8_t auxiliary_id;       /* Identify auxiliary connections */
 530     enum ofputil_capabilities capabilities;
 531     enum ofputil_action_bitmap actions;
 532 };
 533
 534 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
 535                                            struct ofputil_switch_features *,
 536                                            struct ofpbuf *);
 537
 538 struct ofpbuf *ofputil_encode_switch_features(
 539     const struct ofputil_switch_features *, enum ofputil_protocol,
 540     ovs_be32 xid);
 541 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
 542                                       struct ofpbuf *);
 543 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
 544
 545 /* phy_port helper functions. */
 546 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
 547                           struct ofputil_phy_port *);
 548 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
 549
 550 /* Abstract ofp_port_status. */
 551 struct ofputil_port_status {
 552     enum ofp_port_reason reason;
 553     struct ofputil_phy_port desc;
 554 };
 555
 556 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
 557                                        struct ofputil_port_status *);
 558 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
 559                                           enum ofputil_protocol);
 560
 561 /* Abstract ofp_port_mod. */
 562 struct ofputil_port_mod {
 563     ofp_port_t port_no;
 564     uint8_t hw_addr[OFP_ETH_ALEN];
 565     enum ofputil_port_config config;
 566     enum ofputil_port_config mask;
 567     enum netdev_features advertise;
 568 };
 569
 570 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
 571                                     struct ofputil_port_mod *);
 572 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
 573                                        enum ofputil_protocol);
 574
 575 /* Abstract ofp_table_mod. */
 576 struct ofputil_table_mod {
 577     uint8_t table_id;         /* ID of the table, 0xff indicates all tables. */
 578     uint32_t config;
 579 };
 580
 581 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
 582                                     struct ofputil_table_mod *);
 583 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
 584                                        enum ofputil_protocol);
 585
 586 /* Meter band configuration for all supported band types. */
 587 struct ofputil_meter_band {
 588     uint16_t type;
 589     uint8_t prec_level;         /* Non-zero if type == OFPMBT_DSCP_REMARK. */
 590     uint32_t rate;
 591     uint32_t burst_size;
 592 };
 593
 594 struct ofputil_meter_band_stats {
 595     uint64_t packet_count;
 596     uint64_t byte_count;
 597 };
 598
 599 struct ofputil_meter_config {
 600     uint32_t meter_id;
 601     uint16_t flags;
 602     uint16_t n_bands;
 603     struct ofputil_meter_band *bands;
 604 };
 605
 606 /* Abstract ofp_meter_mod. */
 607 struct ofputil_meter_mod {
 608     uint16_t command;
 609     struct ofputil_meter_config meter;
 610 };
 611
 612 struct ofputil_meter_stats {
 613     uint32_t meter_id;
 614     uint32_t flow_count;
 615     uint64_t packet_in_count;
 616     uint64_t byte_in_count;
 617     uint32_t duration_sec;
 618     uint32_t duration_nsec;
 619     uint16_t n_bands;
 620     struct ofputil_meter_band_stats *bands;
 621 };
 622
 623 struct ofputil_meter_features {
 624     uint32_t max_meters;        /* Maximum number of meters. */
 625     uint32_t band_types;        /* Can support max 32 band types. */
 626     uint32_t capabilities;      /* Supported flags. */
 627     uint8_t  max_bands;
 628     uint8_t  max_color;
 629 };
 630
 631 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
 632                                      struct ofputil_meter_mod *,
 633                                      struct ofpbuf *bands);
 634 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
 635                                         const struct ofputil_meter_mod *);
 636
 637 void ofputil_decode_meter_features(const struct ofp_header *,
 638                                    struct ofputil_meter_features *);
 639 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
 640                                                    ofputil_meter_features *,
 641                                                    const struct ofp_header *
 642                                                    request);
 643 void ofputil_decode_meter_request(const struct ofp_header *,
 644                                   uint32_t *meter_id);
 645
 646 void ofputil_append_meter_config(struct list *replies,
 647                                  const struct ofputil_meter_config *);
 648
 649 void ofputil_append_meter_stats(struct list *replies,
 650                                 const struct ofputil_meter_stats *);
 651
 652 enum ofputil_meter_request_type {
 653     OFPUTIL_METER_FEATURES,
 654     OFPUTIL_METER_CONFIG,
 655     OFPUTIL_METER_STATS
 656 };
 657
 658 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
 659                                             enum ofputil_meter_request_type,
 660                                             uint32_t meter_id);
 661
 662 int ofputil_decode_meter_stats(struct ofpbuf *,
 663                                struct ofputil_meter_stats *,
 664                                struct ofpbuf *bands);
 665
 666 int ofputil_decode_meter_config(struct ofpbuf *,
 667                                 struct ofputil_meter_config *,
 668                                 struct ofpbuf *bands);
 669
 670 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
 671 typedef struct { uint32_t uint32; } ofproto_meter_id;
 672
 673 /* Abstract ofp_role_request and reply. */
 674 struct ofputil_role_request {
 675     enum ofp12_controller_role role;
 676     bool have_generation_id;
 677     uint64_t generation_id;
 678 };
 679
 680 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
 681                                         struct ofputil_role_request *);
 682 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
 683                                          const struct ofputil_role_request *);
 684
 685 /* Abstract table stats.
 686  *
 687  * For now we use ofp12_table_stats as a superset of the other protocol
 688  * versions' table stats. */
 689
 690 struct ofpbuf *ofputil_encode_table_stats_reply(
 691     const struct ofp12_table_stats[], int n,
 692     const struct ofp_header *request);
 693
 694 /* Abstract nx_flow_monitor_request. */
 695 struct ofputil_flow_monitor_request {
 696     uint32_t id;
 697     enum nx_flow_monitor_flags flags;
 698     ofp_port_t out_port;
 699     uint8_t table_id;
 700     struct match match;
 701 };
 702
 703 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
 704                                         struct ofpbuf *msg);
 705 void ofputil_append_flow_monitor_request(
 706     const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
 707
 708 /* Abstract nx_flow_update. */
 709 struct ofputil_flow_update {
 710     enum nx_flow_update_event event;
 711
 712     /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
 713     enum ofp_flow_removed_reason reason;
 714     uint16_t idle_timeout;
 715     uint16_t hard_timeout;
 716     uint8_t table_id;
 717     ovs_be64 cookie;
 718     struct match *match;
 719     uint16_t priority;
 720     struct ofpact *ofpacts;
 721     size_t ofpacts_len;
 722
 723     /* Used only for NXFME_ABBREV. */
 724     ovs_be32 xid;
 725 };
 726
 727 int ofputil_decode_flow_update(struct ofputil_flow_update *,
 728                                struct ofpbuf *msg, struct ofpbuf *ofpacts);
 729 void ofputil_start_flow_update(struct list *replies);
 730 void ofputil_append_flow_update(const struct ofputil_flow_update *,
 731                                 struct list *replies);
 732
 733 /* Abstract nx_flow_monitor_cancel. */
 734 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
 735 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
 736
 737 /* Encoding OpenFlow stats messages. */
 738 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
 739                                           const struct ofputil_phy_port *pp,
 740                                           struct list *replies);
 741
 742 /* Encoding simple OpenFlow messages. */
 743 struct ofpbuf *make_echo_request(enum ofp_version);
 744 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 745
 746 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
 747
 748 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 749 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 750
 751 \f
 752 /* Actions. */
 753
 754 /* The type of an action.
 755  *
 756  * For each implemented OFPAT10_* and NXAST_* action type, there is a
 757  * corresponding constant prefixed with OFPUTIL_, e.g.:
 758  *
 759  * OFPUTIL_OFPAT10_OUTPUT
 760  * OFPUTIL_OFPAT10_SET_VLAN_VID
 761  * OFPUTIL_OFPAT10_SET_VLAN_PCP
 762  * OFPUTIL_OFPAT10_STRIP_VLAN
 763  * OFPUTIL_OFPAT10_SET_DL_SRC
 764  * OFPUTIL_OFPAT10_SET_DL_DST
 765  * OFPUTIL_OFPAT10_SET_NW_SRC
 766  * OFPUTIL_OFPAT10_SET_NW_DST
 767  * OFPUTIL_OFPAT10_SET_NW_TOS
 768  * OFPUTIL_OFPAT10_SET_TP_SRC
 769  * OFPUTIL_OFPAT10_SET_TP_DST
 770  * OFPUTIL_OFPAT10_ENQUEUE
 771  * OFPUTIL_NXAST_RESUBMIT
 772  * OFPUTIL_NXAST_SET_TUNNEL
 773  * OFPUTIL_NXAST_SET_METADATA
 774  * OFPUTIL_NXAST_SET_QUEUE
 775  * OFPUTIL_NXAST_POP_QUEUE
 776  * OFPUTIL_NXAST_REG_MOVE
 777  * OFPUTIL_NXAST_REG_LOAD
 778  * OFPUTIL_NXAST_NOTE
 779  * OFPUTIL_NXAST_SET_TUNNEL64
 780  * OFPUTIL_NXAST_MULTIPATH
 781  * OFPUTIL_NXAST_BUNDLE
 782  * OFPUTIL_NXAST_BUNDLE_LOAD
 783  * OFPUTIL_NXAST_RESUBMIT_TABLE
 784  * OFPUTIL_NXAST_OUTPUT_REG
 785  * OFPUTIL_NXAST_LEARN
 786  * OFPUTIL_NXAST_DEC_TTL
 787  * OFPUTIL_NXAST_FIN_TIMEOUT
 788  *
 789  * (The above list helps developers who want to "grep" for these definitions.)
 790  */
 791 enum OVS_PACKED_ENUM ofputil_action_code {
 792     OFPUTIL_ACTION_INVALID,
 793 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 794 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 795 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   OFPUTIL_##ENUM,
 796 #include "ofp-util.def"
 797 };
 798
 799 /* The number of values of "enum ofputil_action_code". */
 800 enum {
 801 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
 802 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 803 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   + 1
 804     OFPUTIL_N_ACTIONS = 1
 805 #include "ofp-util.def"
 806 };
 807
 808 int ofputil_action_code_from_name(const char *);
 809
 810 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 811
 812 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 813  * struct <STRUCT>, this defines two functions:
 814  *
 815  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 816  *
 817  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 818  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 819  *     variable length, the length used and cleared is that of struct <STRUCT>.
 820  *
 821  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 822  *
 823  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 824  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 825  */
 826 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
 827     void ofputil_init_##ENUM(struct STRUCT *);          \
 828     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 829 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
 830     void ofputil_init_##ENUM(struct STRUCT *);          \
 831     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 832 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 833     void ofputil_init_##ENUM(struct STRUCT *);          \
 834     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 835 #include "ofp-util.def"
 836
 837 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 838
 839 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 840
 841 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 842                                  union ofp_action **, size_t *);
 843
 844 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 845                            const union ofp_action *b, size_t n_b);
 846 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 847
 848 /* Handy utility for parsing flows and actions. */
 849 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 850
 851 struct ofputil_port_stats {
 852     ofp_port_t port_no;
 853     struct netdev_stats stats;
 854     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
 855     uint32_t duration_nsec;
 856 };
 857
 858 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
 859                                                  ofp_port_t port);
 860 void ofputil_append_port_stat(struct list *replies,
 861                               const struct ofputil_port_stats *ops);
 862 size_t ofputil_count_port_stats(const struct ofp_header *);
 863 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
 864 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
 865                                               ofp_port_t *ofp10_port);
 866
 867 struct ofputil_queue_stats_request {
 868     ofp_port_t port_no;           /* OFPP_ANY means "all ports". */
 869     uint32_t queue_id;
 870 };
 871
 872 enum ofperr
 873 ofputil_decode_queue_stats_request(const struct ofp_header *request,
 874                                    struct ofputil_queue_stats_request *oqsr);
 875 struct ofpbuf *
 876 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
 877                                    const struct ofputil_queue_stats_request *oqsr);
 878
 879 struct ofputil_queue_stats {
 880     ofp_port_t port_no;
 881     uint32_t queue_id;
 882
 883     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 884     uint64_t tx_bytes;
 885     uint64_t tx_packets;
 886     uint64_t tx_errors;
 887
 888     /* UINT32_MAX if unknown. */
 889     uint32_t duration_sec;
 890     uint32_t duration_nsec;
 891 };
 892
 893 size_t ofputil_count_queue_stats(const struct ofp_header *);
 894 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
 895 void ofputil_append_queue_stat(struct list *replies,
 896                                const struct ofputil_queue_stats *oqs);
 897
 898 /* Bucket for use in groups. */
 899 struct ofputil_bucket {
 900     struct list list_node;
 901     uint16_t weight;            /* Relative weight, for "select" groups. */
 902     ofp_port_t watch_port;      /* Port whose state affects whether this bucket
 903                                  * is live. Only required for fast failover
 904                                  * groups. */
 905     uint32_t watch_group;       /* Group whose state affects whether this
 906                                  * bucket is live. Only required for fast
 907                                  * failover groups. */
 908     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
 909     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
 910 };
 911
 912 /* Protocol-independent group_mod. */
 913 struct ofputil_group_mod {
 914     uint16_t command;             /* One of OFPGC11_*. */
 915     uint8_t type;                 /* One of OFPGT11_*. */
 916     uint32_t group_id;            /* Group identifier. */
 917     struct list buckets;          /* Contains "struct ofputil_bucket"s. */
 918 };
 919
 920 struct bucket_counter {
 921     uint64_t packet_count;   /* Number of packets processed by bucket. */
 922     uint64_t byte_count;     /* Number of bytes processed by bucket. */
 923 };
 924
 925 /* Group stats reply, independent of protocol. */
 926 struct ofputil_group_stats {
 927     uint32_t group_id;    /* Group identifier. */
 928     uint32_t ref_count;
 929     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 930     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 931     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
 932     uint32_t duration_nsec;
 933     uint32_t n_buckets;
 934     struct bucket_counter *bucket_stats;
 935 };
 936
 937 /* Group features reply, independent of protocol. */
 938 struct ofputil_group_features {
 939     uint32_t  types;           /* Bitmap of OFPGT_* values supported. */
 940     uint32_t  capabilities;    /* Bitmap of OFPGFC12_* capability supported. */
 941     uint32_t  max_groups[4];   /* Maximum number of groups for each type. */
 942     uint32_t  actions[4];      /* Bitmaps of OFPAT_* that are supported. */
 943 };
 944
 945 /* Group desc reply, independent of protocol. */
 946 struct ofputil_group_desc {
 947     uint8_t type;               /* One of OFPGT_*. */
 948     uint32_t group_id;          /* Group identifier. */
 949     struct list buckets;        /* Contains "struct ofputil_bucket"s. */
 950 };
 951
 952 void ofputil_bucket_list_destroy(struct list *buckets);
 953
 954 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
 955                                                   uint32_t group_id);
 956 enum ofperr ofputil_decode_group_stats_request(
 957     const struct ofp_header *request, uint32_t *group_id);
 958 void ofputil_append_group_stats(struct list *replies,
 959                                 const struct ofputil_group_stats *);
 960 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
 961 struct ofpbuf *ofputil_encode_group_features_reply(
 962     const struct ofputil_group_features *, const struct ofp_header *request);
 963 void ofputil_decode_group_features_reply(const struct ofp_header *,
 964                                          struct ofputil_group_features *);
 965 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
 966                                         const struct ofputil_group_mod *gm);
 967
 968 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
 969                                      struct ofputil_group_mod *);
 970
 971 int ofputil_decode_group_stats_reply(struct ofpbuf *,
 972                                      struct ofputil_group_stats *);
 973
 974 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
 975                                     struct ofpbuf *, enum ofp_version);
 976
 977 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
 978                                      struct list *buckets,
 979                                      struct list *replies);
 980 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version);
 981
 982 #endif /* ofp-util.h */