lib/ofp-util.h

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