lib/ofp-util.h

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