lib/ofp-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "meta-flow.h"
  29 #include "netdev.h"
  30 #include "openflow/netronome-ext.h"
  31 #include "openflow/nicira-ext.h"
  32 #include "openvswitch/types.h"
  33 #include "type-props.h"
  34
  35 struct ofpbuf;
  36 union ofp_action;
  37 struct ofpact_set_field;
  38 struct pktbuf;
  39
  40 /* Port numbers. */
  41 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
  42                                     ofp_port_t *ofp10_port);
  43 ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
  44
  45 bool ofputil_port_from_string(const char *, ofp_port_t *portp);
  46 void ofputil_format_port(ofp_port_t port, struct ds *);
  47 void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
  48                             size_t bufsize);
  49
  50 /* Group numbers. */
  51 enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
  52 bool ofputil_group_from_string(const char *, uint32_t *group_id);
  53 void ofputil_format_group(uint32_t group_id, struct ds *);
  54 void ofputil_group_to_string(uint32_t group_id,
  55                              char namebuf[MAX_GROUP_NAME_LEN + 1],
  56                              size_t bufsize);
  57
  58 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
  59  * to and from IP bitmasks. */
  60 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
  61 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
  62
  63 /* Protocols.
  64  *
  65  * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
  66  * a bit extra about the flow match format in use.
  67  *
  68  * These are arranged from most portable to least portable, or alternatively
  69  * from least powerful to most powerful.  Protocols earlier on the list are
  70  * more likely to be understood for the purpose of making requests, but
  71  * protocol later on the list are more likely to accurately describe a flow
  72  * within a switch.
  73  *
  74  * On any given OpenFlow connection, a single protocol is in effect at any
  75  * given time.  These values use separate bits only because that makes it easy
  76  * to test whether a particular protocol is within a given set of protocols and
  77  * to implement set union and intersection.
  78  */
  79 enum ofputil_protocol {
  80     /* OpenFlow 1.0 protocols.
  81      *
  82      * The "STD" protocols use the standard OpenFlow 1.0 flow format.
  83      * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
  84      *
  85      * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
  86      * extension has been enabled.  The other protocols have it disabled.
  87      */
  88 #define OFPUTIL_P_NONE 0
  89     OFPUTIL_P_OF10_STD     = 1 << 0,
  90     OFPUTIL_P_OF10_STD_TID = 1 << 1,
  91     OFPUTIL_P_OF10_NXM     = 1 << 2,
  92     OFPUTIL_P_OF10_NXM_TID = 1 << 3,
  93 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
  94 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
  95 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY)
  96
  97     /* OpenFlow 1.1 protocol.
  98      *
  99      * We only support the standard OpenFlow 1.1 flow format.
 100      *
 101      * OpenFlow 1.1 always operates with an equivalent of the
 102      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
 103      * variant. */
 104     OFPUTIL_P_OF11_STD     = 1 << 4,
 105
 106     /* OpenFlow 1.2+ protocols (only one variant each).
 107      *
 108      * These use the standard OpenFlow Extensible Match (OXM) flow format.
 109      *
 110      * OpenFlow 1.2+ always operates with an equivalent of the
 111      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
 112      * variant. */
 113     OFPUTIL_P_OF12_OXM      = 1 << 5,
 114     OFPUTIL_P_OF13_OXM      = 1 << 6,
 115     OFPUTIL_P_OF14_OXM      = 1 << 7,
 116     OFPUTIL_P_OF15_OXM      = 1 << 8,
 117 #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | \
 118                            OFPUTIL_P_OF13_OXM | \
 119                            OFPUTIL_P_OF14_OXM | \
 120                            OFPUTIL_P_OF15_OXM)
 121
 122 #define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
 123                                OFPUTIL_P_ANY_OXM)
 124
 125 #define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
 126
 127 #define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
 128
 129 #define OFPUTIL_P_OF12_UP (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_UP)
 130 #define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM | OFPUTIL_P_OF14_UP)
 131 #define OFPUTIL_P_OF14_UP (OFPUTIL_P_OF14_OXM | OFPUTIL_P_OF15_UP)
 132 #define OFPUTIL_P_OF15_UP OFPUTIL_P_OF15_OXM
 133
 134     /* All protocols. */
 135 #define OFPUTIL_P_ANY ((1 << 9) - 1)
 136
 137     /* Protocols in which a specific table may be specified in flow_mods. */
 138 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
 139                        OFPUTIL_P_OF10_NXM_TID | \
 140                        OFPUTIL_P_OF11_STD |     \
 141                        OFPUTIL_P_ANY_OXM)
 142 };
 143
 144 /* Protocols to use for flow dumps, from most to least preferred. */
 145 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
 146 extern size_t ofputil_n_flow_dump_protocols;
 147
 148 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
 149 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
 150 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
 151
 152 bool ofputil_protocol_is_valid(enum ofputil_protocol);
 153 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
 154                                                bool enable);
 155 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
 156 enum ofputil_protocol ofputil_protocol_set_base(
 157     enum ofputil_protocol cur, enum ofputil_protocol new_base);
 158
 159 const char *ofputil_protocol_to_string(enum ofputil_protocol);
 160 char *ofputil_protocols_to_string(enum ofputil_protocol);
 161 enum ofputil_protocol ofputil_protocols_from_string(const char *);
 162
 163 void ofputil_format_version(struct ds *, enum ofp_version);
 164 void ofputil_format_version_name(struct ds *, enum ofp_version);
 165
 166 /* A bitmap of version numbers
 167  *
 168  * Bit offsets correspond to ofp_version numbers which in turn correspond to
 169  * wire-protocol numbers for OpenFlow versions, e.g. (1u << OFP11_VERSION)
 170  * is the mask for OpenFlow 1.1.  If the bit for a version is set then it is
 171  * allowed, otherwise it is disallowed. */
 172
 173 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
 174 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
 175
 176 enum ofp_version ofputil_version_from_string(const char *s);
 177
 178 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
 179 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
 180
 181 /* Bitmaps of OpenFlow versions that Open vSwitch supports, and that it enables
 182  * by default.  When Open vSwitch has experimental or incomplete support for
 183  * newer versions of OpenFlow, those versions should not be supported by
 184  * default and thus should be omitted from the latter bitmap. */
 185 #define OFPUTIL_SUPPORTED_VERSIONS ((1u << OFP10_VERSION) | \
 186                                     (1u << OFP11_VERSION) | \
 187                                     (1u << OFP12_VERSION) | \
 188                                     (1u << OFP13_VERSION))
 189 #define OFPUTIL_DEFAULT_VERSIONS OFPUTIL_SUPPORTED_VERSIONS
 190
 191 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
 192
 193 const char *ofputil_version_to_string(enum ofp_version ofp_version);
 194 uint32_t ofputil_versions_from_string(const char *s);
 195 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
 196
 197 bool ofputil_decode_hello(const struct ofp_header *,
 198                           uint32_t *allowed_versions);
 199 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
 200
 201 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
 202                                            enum ofputil_protocol want,
 203                                            enum ofputil_protocol *next);
 204
 205 /* nx_flow_format */
 206 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
 207 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
 208 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
 209 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
 210
 211 /* Work with ofp10_match. */
 212 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
 213 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
 214                                     struct match *);
 215 void ofputil_normalize_match(struct match *);
 216 void ofputil_normalize_match_quiet(struct match *);
 217 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
 218
 219 /* Work with ofp11_match. */
 220 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
 221                                      uint16_t *padded_match_len);
 222 enum ofperr ofputil_pull_ofp11_mask(struct ofpbuf *, struct match *,
 223                                     struct mf_bitmap *bm);
 224 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
 225                                            struct match *);
 226 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
 227                             enum ofputil_protocol);
 228 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
 229 int ofputil_match_typical_len(enum ofputil_protocol);
 230
 231 /* dl_type translation between OpenFlow and 'struct flow' format. */
 232 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 233 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 234
 235 /* PACKET_IN. */
 236 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 237 int ofputil_packet_in_format_from_string(const char *);
 238 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 239 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
 240                                                  enum nx_packet_in_format);
 241
 242 /* NXT_FLOW_MOD_TABLE_ID extension. */
 243 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 244
 245 /* Protocol-independent flow_mod flags. */
 246 enum ofputil_flow_mod_flags {
 247     /* Flags that are maintained with a flow as part of its state.
 248      *
 249      * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
 250     OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
 251     OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
 252     OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
 253
 254     /* These flags primarily affects flow_mod behavior.  They are not
 255      * particularly useful as part of flow state.  We include them in flow
 256      * state only because OpenFlow implies that they should be. */
 257     OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
 258     OFPUTIL_FF_RESET_COUNTS  = 1 << 4, /* OpenFlow 1.2+. */
 259
 260     /* Not supported by OVS. */
 261     OFPUTIL_FF_EMERG         = 1 << 5, /* OpenFlow 1.0 only. */
 262
 263     /* The set of flags maintained as part of a flow table entry. */
 264 #define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM      \
 265                           | OFPUTIL_FF_NO_PKT_COUNTS    \
 266                           | OFPUTIL_FF_NO_BYT_COUNTS    \
 267                           | OFPUTIL_FF_CHECK_OVERLAP    \
 268                           | OFPUTIL_FF_RESET_COUNTS)
 269
 270     /* Flags that are only set by OVS for its internal use.  Cannot be set via
 271      * OpenFlow. */
 272     OFPUTIL_FF_HIDDEN_FIELDS = 1 << 6, /* Allow hidden match fields to be
 273                                           set or modified. */
 274     OFPUTIL_FF_NO_READONLY   = 1 << 7, /* Allow rules within read only tables
 275                                           to be modified */
 276 };
 277
 278 /* Protocol-independent flow_mod.
 279  *
 280  * The handling of cookies across multiple versions of OpenFlow is a bit
 281  * confusing.  See DESIGN for the details. */
 282 struct ofputil_flow_mod {
 283     struct ovs_list list_node; /* For queuing flow_mods. */
 284
 285     struct match match;
 286     int priority;
 287
 288     /* Cookie matching.  The flow_mod affects only flows that have cookies that
 289      * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
 290      *
 291      * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
 292     ovs_be64 cookie;         /* Cookie bits to match. */
 293     ovs_be64 cookie_mask;    /* 1-bit in each 'cookie' bit to match. */
 294
 295     /* Cookie changes.
 296      *
 297      * OFPFC_ADD uses 'new_cookie' as the new flow's cookie.  'new_cookie'
 298      * should not be UINT64_MAX.
 299      *
 300      * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
 301      *
 302      *   - If one or more matching flows exist and 'modify_cookie' is true,
 303      *     then the flow_mod changes the existing flows' cookies to
 304      *     'new_cookie'.  'new_cookie' should not be UINT64_MAX.
 305      *
 306      *   - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
 307      *     'cookie_mask' is 0, then the flow_mod adds a new flow with
 308      *     'new_cookie' as its cookie.
 309      */
 310     ovs_be64 new_cookie;     /* New cookie to install or UINT64_MAX. */
 311     bool modify_cookie;      /* Set cookie of existing flow to 'new_cookie'? */
 312
 313     uint8_t table_id;
 314     uint16_t command;
 315     uint16_t idle_timeout;
 316     uint16_t hard_timeout;
 317     uint32_t buffer_id;
 318     ofp_port_t out_port;
 319     uint32_t out_group;
 320     enum ofputil_flow_mod_flags flags;
 321     uint16_t importance;     /* Eviction precedence. */
 322     struct ofpact *ofpacts;  /* Series of "struct ofpact"s. */
 323     size_t ofpacts_len;      /* Length of ofpacts, in bytes. */
 324
 325     /* Reason for delete; ignored for non-delete commands */
 326     enum ofp_flow_removed_reason delete_reason;
 327 };
 328
 329 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 330                                     const struct ofp_header *,
 331                                     enum ofputil_protocol,
 332                                     struct ofpbuf *ofpacts,
 333                                     ofp_port_t max_port,
 334                                     uint8_t max_table);
 335 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 336                                        enum ofputil_protocol);
 337
 338 /* Flow stats or aggregate stats request, independent of protocol. */
 339 struct ofputil_flow_stats_request {
 340     bool aggregate;             /* Aggregate results? */
 341     struct match match;
 342     ovs_be64 cookie;
 343     ovs_be64 cookie_mask;
 344     ofp_port_t out_port;
 345     uint32_t out_group;
 346     uint8_t table_id;
 347 };
 348
 349 enum ofperr ofputil_decode_flow_stats_request(
 350     struct ofputil_flow_stats_request *, const struct ofp_header *);
 351 struct ofpbuf *ofputil_encode_flow_stats_request(
 352     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
 353
 354 /* Flow stats reply, independent of protocol. */
 355 struct ofputil_flow_stats {
 356     struct match match;
 357     ovs_be64 cookie;
 358     uint8_t table_id;
 359     uint16_t priority;
 360     uint16_t idle_timeout;
 361     uint16_t hard_timeout;
 362     uint32_t duration_sec;
 363     uint32_t duration_nsec;
 364     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 365     int hard_age;               /* Seconds since last change, -1 if unknown. */
 366     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 367     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 368     const struct ofpact *ofpacts;
 369     size_t ofpacts_len;
 370     enum ofputil_flow_mod_flags flags;
 371     uint16_t importance;        /* Eviction precedence. */
 372 };
 373
 374 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 375                                     struct ofpbuf *msg,
 376                                     bool flow_age_extension,
 377                                     struct ofpbuf *ofpacts);
 378 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 379                                      struct ovs_list *replies);
 380
 381 /* Aggregate stats reply, independent of protocol. */
 382 struct ofputil_aggregate_stats {
 383     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 384     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 385     uint32_t flow_count;
 386 };
 387
 388 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 389     const struct ofputil_aggregate_stats *stats,
 390     const struct ofp_header *request);
 391 enum ofperr ofputil_decode_aggregate_stats_reply(
 392     struct ofputil_aggregate_stats *,
 393     const struct ofp_header *reply);
 394
 395 /* Flow removed message, independent of protocol. */
 396 struct ofputil_flow_removed {
 397     struct match match;
 398     ovs_be64 cookie;
 399     uint16_t priority;
 400     uint8_t reason;             /* One of OFPRR_*. */
 401     uint8_t table_id;           /* 255 if message didn't include table ID. */
 402     uint32_t duration_sec;
 403     uint32_t duration_nsec;
 404     uint16_t idle_timeout;
 405     uint16_t hard_timeout;
 406     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 407     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 408 };
 409
 410 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 411                                         const struct ofp_header *);
 412 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 413                                            enum ofputil_protocol);
 414
 415 /* Abstract packet-in message.
 416  *
 417  * This omits the 'total_len' and 'buffer_id' fields, which we handle
 418  * differently for encoding and decoding.*/
 419 struct ofputil_packet_in {
 420     /* Packet data and metadata.
 421      *
 422      * On encoding, the full packet should be supplied, but depending on its
 423      * other parameters ofputil_encode_packet_in() might send only the first
 424      * part of the packet.
 425      *
 426      * On decoding, the 'len' bytes in 'packet' might only be the first part of
 427      * the original packet.  ofputil_decode_packet_in() reports the full
 428      * original length of the packet using its 'total_len' output parameter. */
 429     const void *packet;         /* The packet. */
 430     size_t len;                 /* Length of 'packet' in bytes. */
 431
 432     /* Input port and other metadata for packet. */
 433     struct match flow_metadata;
 434
 435     /* Reason that the packet-in is being sent. */
 436     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
 437
 438     /* Information about the OpenFlow flow that triggered the packet-in.
 439      *
 440      * A packet-in triggered by a flow table miss has no associated flow.  In
 441      * that case, 'cookie' is UINT64_MAX. */
 442     uint8_t table_id;                    /* OpenFlow table ID. */
 443     ovs_be64 cookie;                     /* Flow's cookie. */
 444 };
 445
 446 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 447                                         enum ofputil_protocol protocol,
 448                                         enum nx_packet_in_format,
 449                                         uint16_t max_len, struct pktbuf *);
 450
 451 enum ofperr ofputil_decode_packet_in(const struct ofp_header *,
 452                                      struct ofputil_packet_in *,
 453                                      size_t *total_len, uint32_t *buffer_id);
 454
 455 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
 456 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
 457                                                char *reasonbuf,
 458                                                size_t bufsize);
 459 bool ofputil_packet_in_reason_from_string(const char *,
 460                                           enum ofp_packet_in_reason *);
 461
 462 /* Abstract packet-out message.
 463  *
 464  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
 465  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
 466 struct ofputil_packet_out {
 467     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 468     size_t packet_len;          /* Length of packet data in bytes. */
 469     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 470     ofp_port_t in_port;         /* Packet's input port. */
 471     struct ofpact *ofpacts;     /* Actions. */
 472     size_t ofpacts_len;         /* Size of ofpacts in bytes. */
 473 };
 474
 475 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 476                                       const struct ofp_header *,
 477                                       struct ofpbuf *ofpacts);
 478 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
 479                                          enum ofputil_protocol protocol);
 480
 481 enum ofputil_frag_handling {
 482     OFPUTIL_FRAG_NORMAL = OFPC_FRAG_NORMAL,    /* No special handling. */
 483     OFPUTIL_FRAG_DROP = OFPC_FRAG_DROP,        /* Drop fragments. */
 484     OFPUTIL_FRAG_REASM = OFPC_FRAG_REASM,      /* Reassemble (if supported). */
 485     OFPUTIL_FRAG_NX_MATCH = OFPC_FRAG_NX_MATCH /* Match on frag bits. */
 486 };
 487
 488 const char *ofputil_frag_handling_to_string(enum ofputil_frag_handling);
 489 bool ofputil_frag_handling_from_string(const char *,
 490                                        enum ofputil_frag_handling *);
 491
 492 /* Abstract struct ofp_switch_config. */
 493 struct ofputil_switch_config {
 494     /* Fragment handling. */
 495     enum ofputil_frag_handling frag;
 496
 497     /* 0: Do not send packet to controller when decrementing invalid IP TTL.
 498      * 1: Do send packet to controller when decrementing invalid IP TTL.
 499      * -1: Unspecified (only OpenFlow 1.1 and 1.2 support this setting. */
 500     int invalid_ttl_to_controller;
 501
 502     /* Maximum bytes of packet to send to controller on miss. */
 503     uint16_t miss_send_len;
 504 };
 505
 506 void ofputil_decode_get_config_reply(const struct ofp_header *,
 507                                      struct ofputil_switch_config *);
 508 struct ofpbuf *ofputil_encode_get_config_reply(
 509     const struct ofp_header *request, const struct ofputil_switch_config *);
 510
 511 enum ofperr ofputil_decode_set_config(const struct ofp_header *,
 512                                       struct ofputil_switch_config *);
 513 struct ofpbuf *ofputil_encode_set_config(
 514     const struct ofputil_switch_config *, enum ofp_version);
 515
 516 enum ofputil_port_config {
 517     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
 518     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
 519     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
 520     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
 521     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
 522     /* OpenFlow 1.0 only. */
 523     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
 524     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 525     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 526     /* There are no OpenFlow 1.1-only bits. */
 527 };
 528
 529 enum ofputil_port_state {
 530     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
 531     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 532     /* OpenFlow 1.1 only. */
 533     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
 534     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
 535     /* OpenFlow 1.0 only. */
 536     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 537     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 538     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 539     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 540     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 541 };
 542
 543 /* Abstract ofp10_phy_port or ofp11_port. */
 544 struct ofputil_phy_port {
 545     ofp_port_t port_no;
 546     struct eth_addr hw_addr;
 547     char name[OFP_MAX_PORT_NAME_LEN];
 548     enum ofputil_port_config config;
 549     enum ofputil_port_state state;
 550
 551     /* NETDEV_F_* feature bitmasks. */
 552     enum netdev_features curr;       /* Current features. */
 553     enum netdev_features advertised; /* Features advertised by the port. */
 554     enum netdev_features supported;  /* Features supported by the port. */
 555     enum netdev_features peer;       /* Features advertised by peer. */
 556
 557     /* Speed. */
 558     uint32_t curr_speed;        /* Current speed, in kbps. */
 559     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
 560 };
 561
 562 enum ofputil_capabilities {
 563     /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
 564     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 565     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 566     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
 567     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 568     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 569
 570     /* OpenFlow 1.0 and 1.1 share this capability. */
 571     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
 572
 573     /* OpenFlow 1.0 only. */
 574     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
 575
 576     /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
 577     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
 578
 579     /* OpenFlow 1.2 and 1.3 share this capability */
 580     OFPUTIL_C_PORT_BLOCKED   = 1 << 8,  /* Switch will block looping ports */
 581 };
 582
 583 /* Abstract ofp_switch_features. */
 584 struct ofputil_switch_features {
 585     uint64_t datapath_id;       /* Datapath unique ID. */
 586     uint32_t n_buffers;         /* Max packets buffered at once. */
 587     uint8_t n_tables;           /* Number of tables supported by datapath. */
 588     uint8_t auxiliary_id;       /* Identify auxiliary connections */
 589     enum ofputil_capabilities capabilities;
 590     uint64_t ofpacts;           /* Bitmap of OFPACT_* bits. */
 591 };
 592
 593 enum ofperr ofputil_pull_switch_features(struct ofpbuf *,
 594                                          struct ofputil_switch_features *);
 595
 596 struct ofpbuf *ofputil_encode_switch_features(
 597     const struct ofputil_switch_features *, enum ofputil_protocol,
 598     ovs_be32 xid);
 599 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
 600                                       struct ofpbuf *);
 601 bool ofputil_switch_features_has_ports(struct ofpbuf *b);
 602
 603 /* phy_port helper functions. */
 604 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
 605                           struct ofputil_phy_port *);
 606
 607 /* Abstract ofp_port_status. */
 608 struct ofputil_port_status {
 609     enum ofp_port_reason reason;
 610     struct ofputil_phy_port desc;
 611 };
 612
 613 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
 614                                        struct ofputil_port_status *);
 615 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
 616                                           enum ofputil_protocol);
 617
 618 /* Abstract ofp_port_mod. */
 619 struct ofputil_port_mod {
 620     ofp_port_t port_no;
 621     struct eth_addr hw_addr;
 622     enum ofputil_port_config config;
 623     enum ofputil_port_config mask;
 624     enum netdev_features advertise;
 625 };
 626
 627 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
 628                                     struct ofputil_port_mod *, bool loose);
 629 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
 630                                        enum ofputil_protocol);
 631
 632 /* Abstract version of OFPTC11_TABLE_MISS_*.
 633  *
 634  * OpenFlow 1.0 always sends packets that miss to the next flow table, or to
 635  * the controller if they miss in the last flow table.
 636  *
 637  * OpenFlow 1.1 and 1.2 can configure table miss behavior via a "table-mod"
 638  * that specifies "send to controller", "miss", or "drop".
 639  *
 640  * OpenFlow 1.3 and later never sends packets that miss to the controller.
 641  */
 642 enum ofputil_table_miss {
 643     /* Protocol-specific default behavior.  On OpenFlow 1.0 through 1.2
 644      * connections, the packet is sent to the controller, and on OpenFlow 1.3
 645      * and later connections, the packet is dropped.
 646      *
 647      * This is also used as a result of decoding OpenFlow 1.3+ "config" values
 648      * in table-mods, to indicate that no table-miss was specified. */
 649     OFPUTIL_TABLE_MISS_DEFAULT,    /* Protocol default behavior. */
 650
 651     /* These constants have the same meanings as those in OpenFlow with the
 652      * same names. */
 653     OFPUTIL_TABLE_MISS_CONTROLLER, /* Send to controller. */
 654     OFPUTIL_TABLE_MISS_CONTINUE,   /* Go to next table. */
 655     OFPUTIL_TABLE_MISS_DROP,       /* Drop the packet. */
 656 };
 657
 658 /* Abstract version of OFPTC14_EVICTION.
 659  *
 660  * OpenFlow 1.0 through 1.3 don't know anything about eviction, so decoding a
 661  * message for one of these protocols always yields
 662  * OFPUTIL_TABLE_EVICTION_DEFAULT. */
 663 enum ofputil_table_eviction {
 664     OFPUTIL_TABLE_EVICTION_DEFAULT, /* No value. */
 665     OFPUTIL_TABLE_EVICTION_ON,      /* Enable eviction. */
 666     OFPUTIL_TABLE_EVICTION_OFF      /* Disable eviction. */
 667 };
 668
 669 /* Abstract version of OFPTC14_VACANCY_EVENTS.
 670  *
 671  * OpenFlow 1.0 through 1.3 don't know anything about vacancy events, so
 672  * decoding a message for one of these protocols always yields
 673  * OFPUTIL_TABLE_VACANCY_DEFAULT. */
 674 enum ofputil_table_vacancy {
 675     OFPUTIL_TABLE_VACANCY_DEFAULT, /* No value. */
 676     OFPUTIL_TABLE_VACANCY_ON,      /* Enable vacancy events. */
 677     OFPUTIL_TABLE_VACANCY_OFF      /* Disable vacancy events. */
 678 };
 679
 680 /* Abstract version of OFPTMPT_VACANCY.
 681  *
 682  * Openflow 1.4+ defines vacancy events.
 683  * The fields vacancy_down and vacancy_up are the threshold for generating
 684  * vacancy events that should be configured on the flow table, expressed as
 685  * a percent.
 686  * The vacancy field is only used when this property in included in a
 687  * OFPMP_TABLE_DESC multipart reply or a OFPT_TABLE_STATUS message and
 688  * represent the current vacancy of the table, expressed as a percent. In
 689  * OFP_TABLE_MOD requests, this field must be set to 0 */
 690 struct ofputil_table_mod_prop_vacancy {
 691     uint8_t vacancy_down;    /* Vacancy threshold when space decreases (%). */
 692     uint8_t vacancy_up;      /* Vacancy threshold when space increases (%). */
 693     uint8_t vacancy;         /* Current vacancy (%). */
 694 };
 695
 696 /* Abstract ofp_table_mod. */
 697 struct ofputil_table_mod {
 698     uint8_t table_id;         /* ID of the table, 0xff indicates all tables. */
 699
 700     /* OpenFlow 1.1 and 1.2 only.  For other versions, ignored on encoding,
 701      * decoded to OFPUTIL_TABLE_MISS_DEFAULT. */
 702     enum ofputil_table_miss miss;
 703
 704     /* OpenFlow 1.4+ only.  For other versions, ignored on encoding, decoded to
 705      * OFPUTIL_TABLE_EVICTION_DEFAULT. */
 706     enum ofputil_table_eviction eviction;
 707
 708     /* OpenFlow 1.4+ only and optional even there; UINT32_MAX indicates
 709      * absence.  For other versions, ignored on encoding, decoded to
 710      * UINT32_MAX.*/
 711     uint32_t eviction_flags;    /* OFPTMPEF14_*. */
 712
 713     /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
 714      * OFPUTIL_TABLE_VACANCY_DEFAULT. */
 715     enum ofputil_table_vacancy vacancy;
 716
 717     /* Openflow 1.4+ only. Defines threshold values of vacancy expressed as
 718      * percent, value of current vacancy is set to zero for table-mod.
 719      * For other versions, ignored on encoding, all values decoded to
 720      * zero. */
 721     struct ofputil_table_mod_prop_vacancy table_vacancy;
 722 };
 723
 724 /* Abstract ofp14_table_desc. */
 725 struct ofputil_table_desc {
 726     uint8_t table_id;         /* ID of the table. */
 727     enum ofputil_table_eviction eviction;
 728     uint32_t eviction_flags;    /* UINT32_MAX if not present. */
 729     enum ofputil_table_vacancy vacancy;
 730     struct ofputil_table_mod_prop_vacancy table_vacancy;
 731 };
 732
 733 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
 734                                     struct ofputil_table_mod *);
 735 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
 736                                        enum ofputil_protocol);
 737
 738 /* Abstract ofp_table_features.
 739  *
 740  * This is used for all versions of OpenFlow, even though ofp_table_features
 741  * was only introduced in OpenFlow 1.3, because earlier versions of OpenFlow
 742  * include support for a subset of ofp_table_features through OFPST_TABLE (aka
 743  * OFPMP_TABLE). */
 744 struct ofputil_table_features {
 745     uint8_t table_id;         /* Identifier of table. Lower numbered tables
 746                                  are consulted first. */
 747     char name[OFP_MAX_TABLE_NAME_LEN];
 748     ovs_be64 metadata_match;  /* Bits of metadata table can match. */
 749     ovs_be64 metadata_write;  /* Bits of metadata table can write. */
 750     uint32_t max_entries;     /* Max number of entries supported. */
 751
 752     /* Flags.
 753      *
 754      * 'miss_config' is relevant for OpenFlow 1.1 and 1.2 only, because those
 755      * versions include OFPTC_MISS_* flags in OFPST_TABLE.  For other versions,
 756      * it is decoded to OFPUTIL_TABLE_MISS_DEFAULT and ignored for encoding.
 757      *
 758      * 'supports_eviction' and 'supports_vacancy_events' are relevant only for
 759      * OpenFlow 1.4 and later only.  For OF1.4, they are boolean: 1 if
 760      * supported, otherwise 0.  For other versions, they are decoded as -1 and
 761      * ignored for encoding.
 762      *
 763      * See the section "OFPTC_* Table Configuration" in DESIGN.md for more
 764      * details of how OpenFlow has changed in this area.
 765      */
 766     enum ofputil_table_miss miss_config; /* OF1.1 and 1.2 only. */
 767     int supports_eviction;               /* OF1.4+ only. */
 768     int supports_vacancy_events;         /* OF1.4+ only. */
 769
 770     /* Table features related to instructions.  There are two instances:
 771      *
 772      *   - 'miss' reports features available in the table miss flow.
 773      *
 774      *   - 'nonmiss' reports features available in other flows. */
 775     struct ofputil_table_instruction_features {
 776         /* Tables that "goto-table" may jump to. */
 777         unsigned long int next[BITMAP_N_LONGS(255)];
 778
 779         /* Bitmap of OVSINST_* for supported instructions. */
 780         uint32_t instructions;
 781
 782         /* Table features related to actions.  There are two instances:
 783          *
 784          *    - 'write' reports features available in a "write_actions"
 785          *      instruction.
 786          *
 787          *    - 'apply' reports features available in an "apply_actions"
 788          *      instruction. */
 789         struct ofputil_table_action_features {
 790             uint64_t ofpacts;     /* Bitmap of supported OFPACT_*. */
 791             struct mf_bitmap set_fields; /* Fields for "set-field". */
 792         } write, apply;
 793     } nonmiss, miss;
 794
 795     /* MFF_* bitmaps.
 796      *
 797      * For any given field the following combinations are valid:
 798      *
 799      *    - match=0, wildcard=0, mask=0: Flows in this table cannot match on
 800      *      this field.
 801      *
 802      *    - match=1, wildcard=0, mask=0: Flows in this table must match on all
 803      *      the bits in this field.
 804      *
 805      *    - match=1, wildcard=1, mask=0: Flows in this table must either match
 806      *      on all the bits in the field or wildcard the field entirely.
 807      *
 808      *    - match=1, wildcard=1, mask=1: Flows in this table may arbitrarily
 809      *      mask this field (as special cases, they may match on all the bits
 810      *      or wildcard it entirely).
 811      *
 812      * Other combinations do not make sense.
 813      */
 814     struct mf_bitmap match;     /* Fields that may be matched. */
 815     struct mf_bitmap mask;      /* Subset of 'match' that may have masks. */
 816     struct mf_bitmap wildcard;  /* Subset of 'match' that may be wildcarded. */
 817 };
 818
 819 int ofputil_decode_table_features(struct ofpbuf *,
 820                                   struct ofputil_table_features *, bool loose);
 821
 822 int ofputil_decode_table_desc(struct ofpbuf *,
 823                               struct ofputil_table_desc *,
 824                               enum ofp_version);
 825
 826 struct ofpbuf *ofputil_encode_table_features_request(enum ofp_version);
 827
 828 struct ofpbuf *ofputil_encode_table_desc_request(enum ofp_version);
 829
 830 void ofputil_append_table_features_reply(
 831     const struct ofputil_table_features *tf, struct ovs_list *replies);
 832
 833 void ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
 834                                      struct ovs_list *replies,
 835                                      enum ofp_version);
 836
 837 /* Meter band configuration for all supported band types. */
 838 struct ofputil_meter_band {
 839     uint16_t type;
 840     uint8_t prec_level;         /* Non-zero if type == OFPMBT_DSCP_REMARK. */
 841     uint32_t rate;
 842     uint32_t burst_size;
 843 };
 844
 845 struct ofputil_meter_band_stats {
 846     uint64_t packet_count;
 847     uint64_t byte_count;
 848 };
 849
 850 struct ofputil_meter_config {
 851     uint32_t meter_id;
 852     uint16_t flags;
 853     uint16_t n_bands;
 854     struct ofputil_meter_band *bands;
 855 };
 856
 857 /* Abstract ofp_meter_mod. */
 858 struct ofputil_meter_mod {
 859     uint16_t command;
 860     struct ofputil_meter_config meter;
 861 };
 862
 863 struct ofputil_meter_stats {
 864     uint32_t meter_id;
 865     uint32_t flow_count;
 866     uint64_t packet_in_count;
 867     uint64_t byte_in_count;
 868     uint32_t duration_sec;
 869     uint32_t duration_nsec;
 870     uint16_t n_bands;
 871     struct ofputil_meter_band_stats *bands;
 872 };
 873
 874 struct ofputil_meter_features {
 875     uint32_t max_meters;        /* Maximum number of meters. */
 876     uint32_t band_types;        /* Can support max 32 band types. */
 877     uint32_t capabilities;      /* Supported flags. */
 878     uint8_t  max_bands;
 879     uint8_t  max_color;
 880 };
 881
 882 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
 883                                      struct ofputil_meter_mod *,
 884                                      struct ofpbuf *bands);
 885 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
 886                                         const struct ofputil_meter_mod *);
 887
 888 void ofputil_decode_meter_features(const struct ofp_header *,
 889                                    struct ofputil_meter_features *);
 890 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
 891                                                    ofputil_meter_features *,
 892                                                    const struct ofp_header *
 893                                                    request);
 894 void ofputil_decode_meter_request(const struct ofp_header *,
 895                                   uint32_t *meter_id);
 896
 897 void ofputil_append_meter_config(struct ovs_list *replies,
 898                                  const struct ofputil_meter_config *);
 899
 900 void ofputil_append_meter_stats(struct ovs_list *replies,
 901                                 const struct ofputil_meter_stats *);
 902
 903 enum ofputil_meter_request_type {
 904     OFPUTIL_METER_FEATURES,
 905     OFPUTIL_METER_CONFIG,
 906     OFPUTIL_METER_STATS
 907 };
 908
 909 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
 910                                             enum ofputil_meter_request_type,
 911                                             uint32_t meter_id);
 912
 913 int ofputil_decode_meter_stats(struct ofpbuf *,
 914                                struct ofputil_meter_stats *,
 915                                struct ofpbuf *bands);
 916
 917 int ofputil_decode_meter_config(struct ofpbuf *,
 918                                 struct ofputil_meter_config *,
 919                                 struct ofpbuf *bands);
 920
 921 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
 922 typedef struct { uint32_t uint32; } ofproto_meter_id;
 923
 924 /* Abstract ofp_role_request and reply. */
 925 struct ofputil_role_request {
 926     enum ofp12_controller_role role;
 927     bool have_generation_id;
 928     uint64_t generation_id;
 929 };
 930
 931 struct ofputil_role_status {
 932     enum ofp12_controller_role role;
 933     enum ofp14_controller_role_reason reason;
 934     uint64_t generation_id;
 935 };
 936
 937 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
 938                                         struct ofputil_role_request *);
 939 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
 940                                          const struct ofputil_role_request *);
 941
 942 struct ofpbuf *ofputil_encode_role_status(
 943                                 const struct ofputil_role_status *status,
 944                                 enum ofputil_protocol protocol);
 945
 946 enum ofperr ofputil_decode_role_status(const struct ofp_header *oh,
 947                                        struct ofputil_role_status *rs);
 948
 949 /* Abstract table stats.
 950  *
 951  * This corresponds to the OpenFlow 1.3 table statistics structure, which only
 952  * includes actual statistics.  In earlier versions of OpenFlow, several
 953  * members describe table features, so this structure has to be paired with
 954  * struct ofputil_table_features to get all information. */
 955 struct ofputil_table_stats {
 956     uint8_t table_id;           /* Identifier of table. */
 957     uint32_t active_count;      /* Number of active entries. */
 958     uint64_t lookup_count;      /* Number of packets looked up in table. */
 959     uint64_t matched_count;     /* Number of packets that hit table. */
 960 };
 961
 962 struct ofpbuf *ofputil_encode_table_stats_reply(const struct ofp_header *rq);
 963
 964 struct ofpbuf *ofputil_encode_table_desc_reply(const struct ofp_header *rq);
 965
 966 void ofputil_append_table_stats_reply(struct ofpbuf *reply,
 967                                       const struct ofputil_table_stats *,
 968                                       const struct ofputil_table_features *);
 969
 970 int ofputil_decode_table_stats_reply(struct ofpbuf *reply,
 971                                      struct ofputil_table_stats *,
 972                                      struct ofputil_table_features *);
 973
 974 /* Queue configuration request. */
 975 struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version,
 976                                                        ofp_port_t port,
 977                                                        uint32_t queue);
 978 enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *,
 979                                                     ofp_port_t *port,
 980                                                     uint32_t *queue);
 981
 982 /* Queue configuration reply. */
 983 struct ofputil_queue_config {
 984     ofp_port_t port;
 985     uint32_t queue;
 986
 987     /* Each of these optional values is expressed in tenths of a percent.
 988      * Values greater than 1000 indicate that the feature is disabled.
 989      * UINT16_MAX indicates that the value is omitted. */
 990     uint16_t min_rate;
 991     uint16_t max_rate;
 992 };
 993
 994 void ofputil_start_queue_get_config_reply(const struct ofp_header *request,
 995                                           struct ovs_list *replies);
 996 void ofputil_append_queue_get_config_reply(
 997     const struct ofputil_queue_config *, struct ovs_list *replies);
 998
 999 int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
1000                                         struct ofputil_queue_config *);
1001
1002
1003 /* Abstract nx_flow_monitor_request. */
1004 struct ofputil_flow_monitor_request {
1005     uint32_t id;
1006     enum nx_flow_monitor_flags flags;
1007     ofp_port_t out_port;
1008     uint8_t table_id;
1009     struct match match;
1010 };
1011
1012 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
1013                                         struct ofpbuf *msg);
1014 void ofputil_append_flow_monitor_request(
1015     const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
1016
1017 /* Abstract nx_flow_update. */
1018 struct ofputil_flow_update {
1019     enum nx_flow_update_event event;
1020
1021     /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
1022     enum ofp_flow_removed_reason reason;
1023     uint16_t idle_timeout;
1024     uint16_t hard_timeout;
1025     uint8_t table_id;
1026     uint16_t priority;
1027     ovs_be64 cookie;
1028     struct match *match;
1029     const struct ofpact *ofpacts;
1030     size_t ofpacts_len;
1031
1032     /* Used only for NXFME_ABBREV. */
1033     ovs_be32 xid;
1034 };
1035
1036 int ofputil_decode_flow_update(struct ofputil_flow_update *,
1037                                struct ofpbuf *msg, struct ofpbuf *ofpacts);
1038 void ofputil_start_flow_update(struct ovs_list *replies);
1039 void ofputil_append_flow_update(const struct ofputil_flow_update *,
1040                                 struct ovs_list *replies);
1041
1042 /* Abstract nx_flow_monitor_cancel. */
1043 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
1044 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
1045
1046 /* Port desc stats requests and replies. */
1047 enum ofperr ofputil_decode_port_desc_stats_request(const struct ofp_header *,
1048                                                    ofp_port_t *portp);
1049 struct ofpbuf *ofputil_encode_port_desc_stats_request(
1050     enum ofp_version ofp_version, ofp_port_t);
1051
1052 void ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
1053                                           struct ovs_list *replies);
1054
1055 /* Encoding simple OpenFlow messages. */
1056 struct ofpbuf *make_echo_request(enum ofp_version);
1057 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
1058
1059 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
1060 \f
1061 /* Actions. */
1062
1063 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
1064
1065 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
1066                                  union ofp_action **, size_t *);
1067
1068 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
1069                            const union ofp_action *b, size_t n_b);
1070 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
1071
1072 /* Handy utility for parsing flows and actions. */
1073 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
1074
1075 struct ofputil_port_stats {
1076     ofp_port_t port_no;
1077     struct netdev_stats stats;
1078     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
1079     uint32_t duration_nsec;
1080 };
1081
1082 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
1083                                                  ofp_port_t port);
1084 void ofputil_append_port_stat(struct ovs_list *replies,
1085                               const struct ofputil_port_stats *ops);
1086 size_t ofputil_count_port_stats(const struct ofp_header *);
1087 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
1088 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
1089                                               ofp_port_t *ofp10_port);
1090
1091 struct ofputil_queue_stats_request {
1092     ofp_port_t port_no;           /* OFPP_ANY means "all ports". */
1093     uint32_t queue_id;
1094 };
1095
1096 enum ofperr
1097 ofputil_decode_queue_stats_request(const struct ofp_header *request,
1098                                    struct ofputil_queue_stats_request *oqsr);
1099 struct ofpbuf *
1100 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
1101                                    const struct ofputil_queue_stats_request *oqsr);
1102
1103 struct ofputil_queue_stats {
1104     ofp_port_t port_no;
1105     uint32_t queue_id;
1106
1107     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
1108     uint64_t tx_bytes;
1109     uint64_t tx_packets;
1110     uint64_t tx_errors;
1111
1112     /* UINT32_MAX if unknown. */
1113     uint32_t duration_sec;
1114     uint32_t duration_nsec;
1115 };
1116
1117 size_t ofputil_count_queue_stats(const struct ofp_header *);
1118 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
1119 void ofputil_append_queue_stat(struct ovs_list *replies,
1120                                const struct ofputil_queue_stats *oqs);
1121
1122 struct bucket_counter {
1123     uint64_t packet_count;   /* Number of packets processed by bucket. */
1124     uint64_t byte_count;     /* Number of bytes processed by bucket. */
1125 };
1126
1127 /* Bucket for use in groups. */
1128 struct ofputil_bucket {
1129     struct ovs_list list_node;
1130     uint16_t weight;            /* Relative weight, for "select" groups. */
1131     ofp_port_t watch_port;      /* Port whose state affects whether this bucket
1132                                  * is live. Only required for fast failover
1133                                  * groups. */
1134     uint32_t watch_group;       /* Group whose state affects whether this
1135                                  * bucket is live. Only required for fast
1136                                  * failover groups. */
1137     uint32_t bucket_id;         /* Bucket Id used to identify bucket*/
1138     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
1139     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
1140
1141     struct bucket_counter stats;
1142 };
1143
1144 /* Protocol-independent group_mod. */
1145 struct ofputil_group_props {
1146     /* NTR selection method */
1147     char selection_method[NTR_MAX_SELECTION_METHOD_LEN];
1148     uint64_t selection_method_param;
1149     struct field_array fields;
1150 };
1151
1152 /* Protocol-independent group_mod. */
1153 struct ofputil_group_mod {
1154     uint16_t command;             /* One of OFPGC15_*. */
1155     uint8_t type;                 /* One of OFPGT11_*. */
1156     uint32_t group_id;            /* Group identifier. */
1157     uint32_t command_bucket_id;   /* Bucket Id used as part of
1158                                    * OFPGC15_INSERT_BUCKET and
1159                                    * OFPGC15_REMOVE_BUCKET commands
1160                                    * execution.*/
1161     struct ovs_list buckets;      /* Contains "struct ofputil_bucket"s. */
1162     struct ofputil_group_props props; /* Group properties. */
1163 };
1164
1165 /* Group stats reply, independent of protocol. */
1166 struct ofputil_group_stats {
1167     uint32_t group_id;    /* Group identifier. */
1168     uint32_t ref_count;
1169     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
1170     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
1171     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
1172     uint32_t duration_nsec;
1173     uint32_t n_buckets;
1174     struct bucket_counter *bucket_stats;
1175 };
1176
1177 /* Group features reply, independent of protocol.
1178  *
1179  * Only OF1.2 and later support group features replies. */
1180 struct ofputil_group_features {
1181     uint32_t  types;           /* Bitmap of OFPGT_* values supported. */
1182     uint32_t  capabilities;    /* Bitmap of OFPGFC12_* capability supported. */
1183     uint32_t  max_groups[4];   /* Maximum number of groups for each type. */
1184     uint64_t  ofpacts[4];      /* Bitmaps of supported OFPACT_* */
1185 };
1186
1187 /* Group desc reply, independent of protocol. */
1188 struct ofputil_group_desc {
1189     uint8_t type;               /* One of OFPGT_*. */
1190     uint32_t group_id;          /* Group identifier. */
1191     struct ovs_list buckets;    /* Contains "struct ofputil_bucket"s. */
1192     struct ofputil_group_props props; /* Group properties. */
1193 };
1194
1195 void ofputil_bucket_list_destroy(struct ovs_list *buckets);
1196 void ofputil_bucket_clone_list(struct ovs_list *dest,
1197                                const struct ovs_list *src,
1198                                const struct ofputil_bucket *);
1199 struct ofputil_bucket *ofputil_bucket_find(const struct ovs_list *,
1200                                            uint32_t bucket_id);
1201 bool ofputil_bucket_check_duplicate_id(const struct ovs_list *);
1202 struct ofputil_bucket *ofputil_bucket_list_front(const struct ovs_list *);
1203 struct ofputil_bucket *ofputil_bucket_list_back(const struct ovs_list *);
1204
1205 static inline bool
1206 ofputil_bucket_has_liveness(const struct ofputil_bucket *bucket)
1207 {
1208     return (bucket->watch_port != OFPP_ANY ||
1209             bucket->watch_group != OFPG_ANY);
1210 }
1211
1212 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
1213                                                   uint32_t group_id);
1214 enum ofperr ofputil_decode_group_stats_request(
1215     const struct ofp_header *request, uint32_t *group_id);
1216 void ofputil_append_group_stats(struct ovs_list *replies,
1217                                 const struct ofputil_group_stats *);
1218 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
1219 struct ofpbuf *ofputil_encode_group_features_reply(
1220     const struct ofputil_group_features *, const struct ofp_header *request);
1221 void ofputil_decode_group_features_reply(const struct ofp_header *,
1222                                          struct ofputil_group_features *);
1223 void ofputil_uninit_group_mod(struct ofputil_group_mod *gm);
1224 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
1225                                         const struct ofputil_group_mod *gm);
1226
1227 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
1228                                      struct ofputil_group_mod *);
1229
1230 int ofputil_decode_group_stats_reply(struct ofpbuf *,
1231                                      struct ofputil_group_stats *);
1232
1233 void ofputil_uninit_group_desc(struct ofputil_group_desc *gd);
1234 uint32_t ofputil_decode_group_desc_request(const struct ofp_header *);
1235 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version,
1236                                                  uint32_t group_id);
1237
1238 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
1239                                     struct ofpbuf *, enum ofp_version);
1240
1241 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
1242                                      const struct ovs_list *buckets,
1243                                      struct ovs_list *replies);
1244
1245 struct ofputil_bundle_ctrl_msg {
1246     uint32_t    bundle_id;
1247     uint16_t    type;
1248     uint16_t    flags;
1249 };
1250
1251 struct ofputil_bundle_add_msg {
1252     uint32_t            bundle_id;
1253     uint16_t            flags;
1254     const struct ofp_header   *msg;
1255 };
1256
1257 enum ofptype;
1258
1259 enum ofperr ofputil_decode_bundle_ctrl(const struct ofp_header *,
1260                                        struct ofputil_bundle_ctrl_msg *);
1261
1262 struct ofpbuf *ofputil_encode_bundle_ctrl_request(enum ofp_version,
1263                                                   struct ofputil_bundle_ctrl_msg *);
1264 struct ofpbuf *ofputil_encode_bundle_ctrl_reply(const struct ofp_header *,
1265                                                 struct ofputil_bundle_ctrl_msg *);
1266
1267 struct ofpbuf *ofputil_encode_bundle_add(enum ofp_version ofp_version,
1268                                          struct ofputil_bundle_add_msg *msg);
1269
1270 enum ofperr ofputil_decode_bundle_add(const struct ofp_header *,
1271                                       struct ofputil_bundle_add_msg *,
1272                                       enum ofptype *type);
1273
1274 struct ofputil_tlv_map {
1275     struct ovs_list list_node;
1276
1277     uint16_t option_class;
1278     uint8_t  option_type;
1279     uint8_t  option_len;
1280     uint16_t index;
1281 };
1282
1283 struct ofputil_tlv_table_mod {
1284     uint16_t command;
1285     struct ovs_list mappings;      /* Contains "struct ofputil_tlv_map"s. */
1286 };
1287
1288 struct ofputil_tlv_table_reply {
1289     uint32_t max_option_space;
1290     uint16_t max_fields;
1291     struct ovs_list mappings;      /* Contains "struct ofputil_tlv_map"s. */
1292 };
1293
1294 struct ofpbuf *ofputil_encode_tlv_table_mod(enum ofp_version ofp_version,
1295                                                struct ofputil_tlv_table_mod *);
1296 enum ofperr ofputil_decode_tlv_table_mod(const struct ofp_header *,
1297                                             struct ofputil_tlv_table_mod *);
1298 struct ofpbuf *ofputil_encode_tlv_table_reply(const struct ofp_header *,
1299                                                struct ofputil_tlv_table_reply *);
1300 enum ofperr ofputil_decode_tlv_table_reply(const struct ofp_header *,
1301                                               struct ofputil_tlv_table_reply *);
1302 void ofputil_uninit_tlv_table(struct ovs_list *mappings);
1303
1304 enum ofputil_async_msg_type {
1305     /* Standard asynchronous messages. */
1306     OAM_PACKET_IN,              /* OFPT_PACKET_IN or NXT_PACKET_IN. */
1307     OAM_PORT_STATUS,            /* OFPT_PORT_STATUS. */
1308     OAM_FLOW_REMOVED,           /* OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED. */
1309     OAM_ROLE_STATUS,            /* OFPT_ROLE_STATUS. */
1310     OAM_TABLE_STATUS,           /* OFPT_TABLE_STATUS. */
1311     OAM_REQUESTFORWARD,         /* OFPT_REQUESTFORWARD. */
1312
1313     /* Extension asynchronous messages (none yet--coming soon!). */
1314 #define OAM_EXTENSIONS 0        /* Bitmap of all extensions. */
1315
1316     OAM_N_TYPES
1317 };
1318 const char *ofputil_async_msg_type_to_string(enum ofputil_async_msg_type);
1319
1320 struct ofputil_async_cfg {
1321     uint32_t master[OAM_N_TYPES];
1322     uint32_t slave[OAM_N_TYPES];
1323 };
1324 #define OFPUTIL_ASYNC_CFG_INIT (struct ofputil_async_cfg) { .master[0] = 0 }
1325
1326 enum ofperr ofputil_decode_set_async_config(const struct ofp_header *,
1327                                             bool loose,
1328                                             const struct ofputil_async_cfg *,
1329                                             struct ofputil_async_cfg *);
1330
1331 struct ofpbuf *ofputil_encode_get_async_reply(
1332     const struct ofp_header *, const struct ofputil_async_cfg *);
1333 struct ofpbuf *ofputil_encode_set_async_config(
1334     const struct ofputil_async_cfg *, uint32_t oams, enum ofp_version);
1335
1336 struct ofputil_async_cfg ofputil_async_cfg_default(enum ofp_version);
1337
1338 struct ofputil_requestforward {
1339     ovs_be32 xid;
1340     enum ofp14_requestforward_reason reason;
1341     union {
1342         /* reason == OFPRFR_METER_MOD. */
1343         struct {
1344             struct ofputil_meter_mod *meter_mod;
1345             struct ofpbuf bands;
1346         };
1347
1348         /* reason == OFPRFR_GROUP_MOD. */
1349         struct ofputil_group_mod *group_mod;
1350     };
1351 };
1352
1353 struct ofpbuf *ofputil_encode_requestforward(
1354     const struct ofputil_requestforward *, enum ofputil_protocol);
1355 enum ofperr ofputil_decode_requestforward(const struct ofp_header *,
1356                                           struct ofputil_requestforward *);
1357 void ofputil_destroy_requestforward(struct ofputil_requestforward *);
1358
1359 #endif /* ofp-util.h */