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