lib/ofp-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 <assert.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24 #include "classifier.h"
  25 #include "compiler.h"
  26 #include "flow.h"
  27 #include "match.h"
  28 #include "netdev.h"
  29 #include "openflow/nicira-ext.h"
  30 #include "openvswitch/types.h"
  31
  32 struct ofpbuf;
  33
  34 /* Port numbers. */
  35 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port);
  36 ovs_be32 ofputil_port_to_ofp11(uint16_t ofp10_port);
  37
  38 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
  39 bool ofputil_port_from_string(const char *, uint16_t *portp);
  40 void ofputil_format_port(uint16_t port, struct ds *);
  41
  42 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
  43  * to and from IP bitmasks. */
  44 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
  45 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
  46
  47 /* Protocols.
  48  *
  49  * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
  50  * a bit extra about the flow match format in use.
  51  *
  52  * These are arranged from most portable to least portable, or alternatively
  53  * from least powerful to most powerful.  Protocols earlier on the list are
  54  * more likely to be understood for the purpose of making requests, but
  55  * protocol later on the list are more likely to accurately describe a flow
  56  * within a switch.
  57  *
  58  * On any given OpenFlow connection, a single protocol is in effect at any
  59  * given time.  These values use separate bits only because that makes it easy
  60  * to test whether a particular protocol is within a given set of protocols and
  61  * to implement set union and intersection.
  62  */
  63 enum ofputil_protocol {
  64     /* OpenFlow 1.0 protocols.
  65      *
  66      * The "STD" protocols use the standard OpenFlow 1.0 flow format.
  67      * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
  68      *
  69      * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
  70      * extension has been enabled.  The other protocols have it disabled.
  71      */
  72 #define OFPUTIL_P_NONE 0
  73     OFPUTIL_P_OF10_STD     = 1 << 0,
  74     OFPUTIL_P_OF10_STD_TID = 1 << 1,
  75     OFPUTIL_P_OF10_NXM     = 1 << 2,
  76     OFPUTIL_P_OF10_NXM_TID = 1 << 3,
  77 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
  78 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
  79
  80     /* OpenFlow 1.2+ protocols (only one variant each).
  81      *
  82      * These use the standard OpenFlow Extensible Match (OXM) flow format.
  83      *
  84      * OpenFlow 1.2+ always operates with an equivalent of the
  85      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
  86      * variant. */
  87     OFPUTIL_P_OF12_OXM      = 1 << 4,
  88     OFPUTIL_P_OF13_OXM      = 1 << 5,
  89
  90     /* All protocols. */
  91 #define OFPUTIL_P_ANY ((1 << 6) - 1)
  92
  93     /* Protocols in which a specific table may be specified in flow_mods. */
  94 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
  95                        OFPUTIL_P_OF10_NXM_TID | \
  96                        OFPUTIL_P_OF12_OXM | \
  97                        OFPUTIL_P_OF13_OXM)
  98 };
  99
 100 /* Protocols to use for flow dumps, from most to least preferred. */
 101 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
 102 extern size_t ofputil_n_flow_dump_protocols;
 103
 104 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
 105 enum ofp_version  ofputil_protocol_to_ofp_version(enum ofputil_protocol);
 106
 107 bool ofputil_protocol_is_valid(enum ofputil_protocol);
 108 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
 109                                                bool enable);
 110 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
 111 enum ofputil_protocol ofputil_protocol_set_base(
 112     enum ofputil_protocol cur, enum ofputil_protocol new_base);
 113
 114 const char *ofputil_protocol_to_string(enum ofputil_protocol);
 115 char *ofputil_protocols_to_string(enum ofputil_protocol);
 116 enum ofputil_protocol ofputil_protocols_from_string(const char *);
 117 enum ofputil_protocol ofputil_usable_protocols(const struct match *);
 118
 119 void ofputil_format_version(struct ds *, enum ofp_version);
 120 void ofputil_format_version_name(struct ds *, enum ofp_version);
 121
 122 /* A bitmap of version numbers
 123  *
 124  * Bit offsets correspond to ofp_version numbers which in turn correspond to
 125  * wire-protocol numbers for Open Flow versions..  E.g. (1u << OFP11_VERSION)
 126  * is the mask for Open Flow 1.1.  If the bit for a version is set then it is
 127  * allowed, otherwise it is disallowed. */
 128
 129 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
 130 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
 131
 132 /* Bitmap of OpenFlow versions that Open vSwitch supports. */
 133 #define OFPUTIL_SUPPORTED_VERSIONS \
 134     ((1u << OFP10_VERSION) | (1u << OFP12_VERSION) | (1u << OFP13_VERSION))
 135
 136 /* Bitmap of OpenFlow versions to enable by default (a subset of
 137  * OFPUTIL_SUPPORTED_VERSIONS). */
 138 #define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
 139
 140 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
 141
 142 const char *ofputil_version_to_string(enum ofp_version ofp_version);
 143 uint32_t ofputil_versions_from_string(const char *s);
 144 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
 145
 146 bool ofputil_decode_hello(const struct ofp_header *,
 147                           uint32_t *allowed_versions);
 148 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
 149
 150 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
 151                                            enum ofputil_protocol want,
 152                                            enum ofputil_protocol *next);
 153
 154 /* nx_flow_format */
 155 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
 156 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
 157 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
 158 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
 159
 160 /* Work with ofp10_match. */
 161 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
 162 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
 163                                     struct match *);
 164 void ofputil_normalize_match(struct match *);
 165 void ofputil_normalize_match_quiet(struct match *);
 166 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
 167
 168 /* Work with ofp11_match. */
 169 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
 170                                      uint16_t *padded_match_len);
 171 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
 172                                            struct match *);
 173 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
 174
 175 /* dl_type translation between OpenFlow and 'struct flow' format. */
 176 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 177 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 178
 179 /* PACKET_IN. */
 180 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 181 int ofputil_packet_in_format_from_string(const char *);
 182 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 183 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
 184                                                  enum nx_packet_in_format);
 185
 186 /* NXT_FLOW_MOD_TABLE_ID extension. */
 187 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 188
 189 /* Protocol-independent flow_mod.
 190  *
 191  * The handling of cookies across multiple versions of OpenFlow is a bit
 192  * confusing.  A full description of Open vSwitch's cookie handling is
 193  * in the DESIGN file.  The following table shows the expected values of
 194  * the cookie-related fields for the different flow_mod commands in
 195  * OpenFlow 1.0 ("OF10") and NXM.  "<used>" and "-" indicate a value
 196  * that may be populated and an ignored field, respectively.
 197  *
 198  *               cookie  cookie_mask  new_cookie
 199  *               ======  ===========  ==========
 200  * OF10 Add        -          0         <used>
 201  * OF10 Modify     -          0         <used>
 202  * OF10 Delete     -          0           -
 203  * NXM Add         -          0         <used>
 204  * NXM Modify    <used>     <used>      <used>
 205  * NXM Delete    <used>     <used>        -
 206  */
 207 struct ofputil_flow_mod {
 208     struct match match;
 209     unsigned int priority;
 210     ovs_be64 cookie;         /* Cookie bits to match. */
 211     ovs_be64 cookie_mask;    /* 1-bit in each 'cookie' bit to match. */
 212     ovs_be64 new_cookie;     /* New cookie to install or -1. */
 213     uint8_t table_id;
 214     uint16_t command;
 215     uint16_t idle_timeout;
 216     uint16_t hard_timeout;
 217     uint32_t buffer_id;
 218     uint16_t out_port;
 219     uint16_t flags;
 220     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
 221     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
 222 };
 223
 224 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 225                                     const struct ofp_header *,
 226                                     enum ofputil_protocol,
 227                                     struct ofpbuf *ofpacts);
 228 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 229                                        enum ofputil_protocol);
 230
 231 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
 232     const struct ofputil_flow_mod *fms, size_t n_fms);
 233
 234 /* Flow stats or aggregate stats request, independent of protocol. */
 235 struct ofputil_flow_stats_request {
 236     bool aggregate;             /* Aggregate results? */
 237     struct match match;
 238     ovs_be64 cookie;
 239     ovs_be64 cookie_mask;
 240     uint16_t out_port;
 241     uint8_t table_id;
 242 };
 243
 244 enum ofperr ofputil_decode_flow_stats_request(
 245     struct ofputil_flow_stats_request *, const struct ofp_header *);
 246 struct ofpbuf *ofputil_encode_flow_stats_request(
 247     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
 248 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
 249     const struct ofputil_flow_stats_request *);
 250
 251 /* Flow stats reply, independent of protocol. */
 252 struct ofputil_flow_stats {
 253     struct match match;
 254     ovs_be64 cookie;
 255     uint8_t table_id;
 256     uint32_t duration_sec;
 257     uint32_t duration_nsec;
 258     uint16_t priority;
 259     uint16_t idle_timeout;
 260     uint16_t hard_timeout;
 261     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 262     int hard_age;               /* Seconds since last change, -1 if unknown. */
 263     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 264     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 265     struct ofpact *ofpacts;
 266     size_t ofpacts_len;
 267     uint16_t flags;             /* Added for OF 1.3 */
 268 };
 269
 270 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 271                                     struct ofpbuf *msg,
 272                                     bool flow_age_extension,
 273                                     struct ofpbuf *ofpacts);
 274 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 275                                      struct list *replies);
 276
 277 /* Aggregate stats reply, independent of protocol. */
 278 struct ofputil_aggregate_stats {
 279     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 280     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 281     uint32_t flow_count;
 282 };
 283
 284 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 285     const struct ofputil_aggregate_stats *stats,
 286     const struct ofp_header *request);
 287 enum ofperr ofputil_decode_aggregate_stats_reply(
 288     struct ofputil_aggregate_stats *,
 289     const struct ofp_header *reply);
 290
 291 /* Flow removed message, independent of protocol. */
 292 struct ofputil_flow_removed {
 293     struct match match;
 294     uint16_t priority;
 295     ovs_be64 cookie;
 296     uint8_t reason;             /* One of OFPRR_*. */
 297     uint8_t table_id;           /* 255 if message didn't include table ID. */
 298     uint32_t duration_sec;
 299     uint32_t duration_nsec;
 300     uint16_t idle_timeout;
 301     uint16_t hard_timeout;
 302     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 303     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 304 };
 305
 306 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 307                                         const struct ofp_header *);
 308 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 309                                            enum ofputil_protocol);
 310
 311 /* Abstract packet-in message. */
 312 struct ofputil_packet_in {
 313     const void *packet;
 314     size_t packet_len;
 315
 316     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
 317     uint16_t controller_id;              /* Controller ID to send to. */
 318     uint8_t table_id;
 319     ovs_be64 cookie;
 320
 321     uint32_t buffer_id;
 322     int send_len;
 323     uint16_t total_len;         /* Full length of frame. */
 324
 325     struct flow_metadata fmd;   /* Metadata at creation time. */
 326 };
 327
 328 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
 329                                      const struct ofp_header *);
 330 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 331                                         enum ofputil_protocol protocol,
 332                                         enum nx_packet_in_format);
 333
 334 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
 335 bool ofputil_packet_in_reason_from_string(const char *,
 336                                           enum ofp_packet_in_reason *);
 337
 338 /* Abstract packet-out message.
 339  *
 340  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
 341  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
 342 struct ofputil_packet_out {
 343     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 344     size_t packet_len;          /* Length of packet data in bytes. */
 345     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 346     uint16_t in_port;           /* Packet's input port. */
 347     struct ofpact *ofpacts;     /* Actions. */
 348     size_t ofpacts_len;         /* Size of ofpacts in bytes. */
 349 };
 350
 351 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 352                                       const struct ofp_header *,
 353                                       struct ofpbuf *ofpacts);
 354 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
 355                                          enum ofputil_protocol protocol);
 356
 357 enum ofputil_port_config {
 358     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
 359     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
 360     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
 361     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
 362     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
 363     /* OpenFlow 1.0 only. */
 364     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
 365     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 366     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 367     /* There are no OpenFlow 1.1-only bits. */
 368 };
 369
 370 enum ofputil_port_state {
 371     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
 372     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 373     /* OpenFlow 1.1 only. */
 374     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
 375     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
 376     /* OpenFlow 1.0 only. */
 377     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 378     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 379     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 380     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 381     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 382 };
 383
 384 /* Abstract ofp10_phy_port or ofp11_port. */
 385 struct ofputil_phy_port {
 386     uint16_t port_no;
 387     uint8_t hw_addr[OFP_ETH_ALEN];
 388     char name[OFP_MAX_PORT_NAME_LEN];
 389     enum ofputil_port_config config;
 390     enum ofputil_port_state state;
 391
 392     /* NETDEV_F_* feature bitmasks. */
 393     enum netdev_features curr;       /* Current features. */
 394     enum netdev_features advertised; /* Features advertised by the port. */
 395     enum netdev_features supported;  /* Features supported by the port. */
 396     enum netdev_features peer;       /* Features advertised by peer. */
 397
 398     /* Speed. */
 399     uint32_t curr_speed;        /* Current speed, in kbps. */
 400     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
 401 };
 402
 403 enum ofputil_capabilities {
 404     /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
 405     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 406     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 407     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
 408     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 409     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 410
 411     /* OpenFlow 1.0 and 1.1 share this capability. */
 412     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
 413
 414     /* OpenFlow 1.0 only. */
 415     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
 416
 417     /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
 418     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
 419
 420     /* OpenFlow 1.2 and 1.3 share this capability */
 421     OFPUTIL_C_PORT_BLOCKED   = 1 << 8,  /* Switch will block looping ports */
 422 };
 423
 424 enum ofputil_action_bitmap {
 425     OFPUTIL_A_OUTPUT         = 1 << 0,
 426     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
 427     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
 428     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
 429     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
 430     OFPUTIL_A_SET_DL_DST     = 1 << 5,
 431     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
 432     OFPUTIL_A_SET_NW_DST     = 1 << 7,
 433     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
 434     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
 435     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
 436     OFPUTIL_A_SET_TP_DST     = 1 << 11,
 437     OFPUTIL_A_ENQUEUE        = 1 << 12,
 438     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
 439     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
 440     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
 441     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
 442     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
 443     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
 444     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
 445     OFPUTIL_A_POP_VLAN       = 1 << 20,
 446     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
 447     OFPUTIL_A_POP_MPLS       = 1 << 22,
 448     OFPUTIL_A_SET_QUEUE      = 1 << 23,
 449     OFPUTIL_A_GROUP          = 1 << 24,
 450     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
 451     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
 452     OFPUTIL_A_SET_FIELD      = 1 << 27,
 453 };
 454
 455 /* Abstract ofp_switch_features. */
 456 struct ofputil_switch_features {
 457     uint64_t datapath_id;       /* Datapath unique ID. */
 458     uint32_t n_buffers;         /* Max packets buffered at once. */
 459     uint8_t n_tables;           /* Number of tables supported by datapath. */
 460     uint8_t auxiliary_id;       /* Identify auxiliary connections */
 461     enum ofputil_capabilities capabilities;
 462     enum ofputil_action_bitmap actions;
 463 };
 464
 465 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
 466                                            struct ofputil_switch_features *,
 467                                            struct ofpbuf *);
 468
 469 struct ofpbuf *ofputil_encode_switch_features(
 470     const struct ofputil_switch_features *, enum ofputil_protocol,
 471     ovs_be32 xid);
 472 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
 473                                       struct ofpbuf *);
 474 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
 475
 476 /* phy_port helper functions. */
 477 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
 478                           struct ofputil_phy_port *);
 479 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
 480
 481 /* Abstract ofp_port_status. */
 482 struct ofputil_port_status {
 483     enum ofp_port_reason reason;
 484     struct ofputil_phy_port desc;
 485 };
 486
 487 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
 488                                        struct ofputil_port_status *);
 489 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
 490                                           enum ofputil_protocol);
 491
 492 /* Abstract ofp_port_mod. */
 493 struct ofputil_port_mod {
 494     uint16_t port_no;
 495     uint8_t hw_addr[OFP_ETH_ALEN];
 496     enum ofputil_port_config config;
 497     enum ofputil_port_config mask;
 498     enum netdev_features advertise;
 499 };
 500
 501 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
 502                                     struct ofputil_port_mod *);
 503 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
 504                                        enum ofputil_protocol);
 505
 506 /* Abstract table stats.
 507  *
 508  * For now we use ofp12_table_stats as a superset of the other protocol
 509  * versions' table stats. */
 510
 511 struct ofpbuf *ofputil_encode_table_stats_reply(
 512     const struct ofp12_table_stats[], int n,
 513     const struct ofp_header *request);
 514
 515 /* Abstract nx_flow_monitor_request. */
 516 struct ofputil_flow_monitor_request {
 517     uint32_t id;
 518     enum nx_flow_monitor_flags flags;
 519     uint16_t out_port;
 520     uint8_t table_id;
 521     struct match match;
 522 };
 523
 524 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
 525                                         struct ofpbuf *msg);
 526 void ofputil_append_flow_monitor_request(
 527     const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
 528
 529 /* Abstract nx_flow_update. */
 530 struct ofputil_flow_update {
 531     enum nx_flow_update_event event;
 532
 533     /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
 534     enum ofp_flow_removed_reason reason;
 535     uint16_t idle_timeout;
 536     uint16_t hard_timeout;
 537     uint8_t table_id;
 538     ovs_be64 cookie;
 539     struct match *match;
 540     uint16_t priority;
 541     struct ofpact *ofpacts;
 542     size_t ofpacts_len;
 543
 544     /* Used only for NXFME_ABBREV. */
 545     ovs_be32 xid;
 546 };
 547
 548 int ofputil_decode_flow_update(struct ofputil_flow_update *,
 549                                struct ofpbuf *msg, struct ofpbuf *ofpacts);
 550 void ofputil_start_flow_update(struct list *replies);
 551 void ofputil_append_flow_update(const struct ofputil_flow_update *,
 552                                 struct list *replies);
 553
 554 /* Abstract nx_flow_monitor_cancel. */
 555 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
 556 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
 557
 558 /* Encoding OpenFlow stats messages. */
 559 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
 560                                           const struct ofputil_phy_port *pp,
 561                                           struct list *replies);
 562
 563 /* Encoding simple OpenFlow messages. */
 564 struct ofpbuf *make_echo_request(enum ofp_version);
 565 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 566
 567 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
 568
 569 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 570 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 571
 572 \f
 573 /* Actions. */
 574
 575 /* The type of an action.
 576  *
 577  * For each implemented OFPAT10_* and NXAST_* action type, there is a
 578  * corresponding constant prefixed with OFPUTIL_, e.g.:
 579  *
 580  * OFPUTIL_OFPAT10_OUTPUT
 581  * OFPUTIL_OFPAT10_SET_VLAN_VID
 582  * OFPUTIL_OFPAT10_SET_VLAN_PCP
 583  * OFPUTIL_OFPAT10_STRIP_VLAN
 584  * OFPUTIL_OFPAT10_SET_DL_SRC
 585  * OFPUTIL_OFPAT10_SET_DL_DST
 586  * OFPUTIL_OFPAT10_SET_NW_SRC
 587  * OFPUTIL_OFPAT10_SET_NW_DST
 588  * OFPUTIL_OFPAT10_SET_NW_TOS
 589  * OFPUTIL_OFPAT10_SET_TP_SRC
 590  * OFPUTIL_OFPAT10_SET_TP_DST
 591  * OFPUTIL_OFPAT10_ENQUEUE
 592  * OFPUTIL_NXAST_RESUBMIT
 593  * OFPUTIL_NXAST_SET_TUNNEL
 594  * OFPUTIL_NXAST_SET_METADATA
 595  * OFPUTIL_NXAST_SET_QUEUE
 596  * OFPUTIL_NXAST_POP_QUEUE
 597  * OFPUTIL_NXAST_REG_MOVE
 598  * OFPUTIL_NXAST_REG_LOAD
 599  * OFPUTIL_NXAST_NOTE
 600  * OFPUTIL_NXAST_SET_TUNNEL64
 601  * OFPUTIL_NXAST_MULTIPATH
 602  * OFPUTIL_NXAST_AUTOPATH
 603  * OFPUTIL_NXAST_BUNDLE
 604  * OFPUTIL_NXAST_BUNDLE_LOAD
 605  * OFPUTIL_NXAST_RESUBMIT_TABLE
 606  * OFPUTIL_NXAST_OUTPUT_REG
 607  * OFPUTIL_NXAST_LEARN
 608  * OFPUTIL_NXAST_DEC_TTL
 609  * OFPUTIL_NXAST_FIN_TIMEOUT
 610  *
 611  * (The above list helps developers who want to "grep" for these definitions.)
 612  */
 613 enum OVS_PACKED_ENUM ofputil_action_code {
 614     OFPUTIL_ACTION_INVALID,
 615 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 616 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 617 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   OFPUTIL_##ENUM,
 618 #include "ofp-util.def"
 619 };
 620
 621 /* The number of values of "enum ofputil_action_code". */
 622 enum {
 623 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
 624 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 625 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   + 1
 626     OFPUTIL_N_ACTIONS = 1
 627 #include "ofp-util.def"
 628 };
 629
 630 int ofputil_action_code_from_name(const char *);
 631
 632 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 633
 634 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 635  * struct <STRUCT>, this defines two functions:
 636  *
 637  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 638  *
 639  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 640  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 641  *     variable length, the length used and cleared is that of struct <STRUCT>.
 642  *
 643  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 644  *
 645  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 646  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 647  */
 648 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
 649     void ofputil_init_##ENUM(struct STRUCT *);          \
 650     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 651 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
 652     void ofputil_init_##ENUM(struct STRUCT *);          \
 653     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 654 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 655     void ofputil_init_##ENUM(struct STRUCT *);          \
 656     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 657 #include "ofp-util.def"
 658
 659 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 660
 661 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
 662                              const struct flow *, int max_ports);
 663 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 664
 665 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 666                                  union ofp_action **, size_t *);
 667
 668 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 669                            const union ofp_action *b, size_t n_b);
 670 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 671
 672 /* Handy utility for parsing flows and actions. */
 673 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 674
 675 struct ofpbuf *ofputlil_dump_ports(enum ofp_version ofp_version, int16_t port);
 676
 677 struct ofputil_port_stats {
 678     uint16_t port_no;
 679     struct netdev_stats stats;
 680 };
 681
 682 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
 683                                                  int16_t port);
 684 void ofputil_append_port_stat(struct list *replies,
 685                               const struct ofputil_port_stats *ops);
 686 size_t ofputil_count_port_stats(const struct ofp_header *);
 687 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
 688 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
 689                                               uint16_t *ofp10_port);
 690
 691 struct ofputil_queue_stats_request {
 692     uint16_t port_no;           /* OFPP_ANY means "all ports". */
 693     uint32_t queue_id;
 694 };
 695
 696 enum ofperr
 697 ofputil_decode_queue_stats_request(const struct ofp_header *request,
 698                                    struct ofputil_queue_stats_request *oqsr);
 699 struct ofpbuf *
 700 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
 701                                    const struct ofputil_queue_stats_request *oqsr);
 702
 703 struct ofputil_queue_stats {
 704     uint16_t port_no;
 705     uint32_t queue_id;
 706     struct netdev_queue_stats stats;
 707 };
 708
 709 size_t ofputil_count_queue_stats(const struct ofp_header *);
 710 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
 711 void ofputil_append_queue_stat(struct list *replies,
 712                                const struct ofputil_queue_stats *oqs);
 713
 714 #endif /* ofp-util.h */