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 #include "type-props.h"
  31
  32 struct ofpbuf;
  33
  34 /* Port numbers. */
  35 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
  36                                     ofp_port_t *ofp10_port);
  37 ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
  38
  39 enum ofperr ofputil_check_output_port(ofp_port_t ofp_port,
  40                                       ofp_port_t max_ports);
  41 bool ofputil_port_from_string(const char *, ofp_port_t *portp);
  42 void ofputil_format_port(ofp_port_t port, struct ds *);
  43 void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
  44                             size_t bufsize);
  45
  46 /* Group numbers. */
  47 enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
  48 bool ofputil_group_from_string(const char *, uint32_t *group_id);
  49 void ofputil_format_group(uint32_t group_id, struct ds *);
  50 void ofputil_group_to_string(uint32_t group_id,
  51                              char namebuf[MAX_GROUP_NAME_LEN + 1],
  52                              size_t bufsize);
  53
  54 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
  55  * to and from IP bitmasks. */
  56 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
  57 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
  58
  59 /* Protocols.
  60  *
  61  * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
  62  * a bit extra about the flow match format in use.
  63  *
  64  * These are arranged from most portable to least portable, or alternatively
  65  * from least powerful to most powerful.  Protocols earlier on the list are
  66  * more likely to be understood for the purpose of making requests, but
  67  * protocol later on the list are more likely to accurately describe a flow
  68  * within a switch.
  69  *
  70  * On any given OpenFlow connection, a single protocol is in effect at any
  71  * given time.  These values use separate bits only because that makes it easy
  72  * to test whether a particular protocol is within a given set of protocols and
  73  * to implement set union and intersection.
  74  */
  75 enum ofputil_protocol {
  76     /* OpenFlow 1.0 protocols.
  77      *
  78      * The "STD" protocols use the standard OpenFlow 1.0 flow format.
  79      * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
  80      *
  81      * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
  82      * extension has been enabled.  The other protocols have it disabled.
  83      */
  84 #define OFPUTIL_P_NONE 0
  85     OFPUTIL_P_OF10_STD     = 1 << 0,
  86     OFPUTIL_P_OF10_STD_TID = 1 << 1,
  87     OFPUTIL_P_OF10_NXM     = 1 << 2,
  88     OFPUTIL_P_OF10_NXM_TID = 1 << 3,
  89 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
  90 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
  91
  92     /* OpenFlow 1.1 protocol.
  93      *
  94      * We only support the standard OpenFlow 1.1 flow format.
  95      *
  96      * OpenFlow 1.1 always operates with an equivalent of the
  97      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
  98      * variant. */
  99     OFPUTIL_P_OF11_STD     = 1 << 4,
 100
 101     /* OpenFlow 1.2+ protocols (only one variant each).
 102      *
 103      * These use the standard OpenFlow Extensible Match (OXM) flow format.
 104      *
 105      * OpenFlow 1.2+ always operates with an equivalent of the
 106      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
 107      * variant. */
 108     OFPUTIL_P_OF12_OXM      = 1 << 5,
 109     OFPUTIL_P_OF13_OXM      = 1 << 6,
 110 #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_OXM)
 111
 112 #define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
 113                                OFPUTIL_P_ANY_OXM)
 114
 115 #define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
 116
 117 #define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
 118
 119 #define OFPUTIL_P_OF12_UP (OFPUTIL_P_ANY_OXM)
 120
 121 #define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM)
 122
 123     /* All protocols. */
 124 #define OFPUTIL_P_ANY ((1 << 7) - 1)
 125
 126     /* Protocols in which a specific table may be specified in flow_mods. */
 127 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
 128                        OFPUTIL_P_OF10_NXM_TID | \
 129                        OFPUTIL_P_OF11_STD |     \
 130                        OFPUTIL_P_ANY_OXM)
 131 };
 132
 133 /* Protocols to use for flow dumps, from most to least preferred. */
 134 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
 135 extern size_t ofputil_n_flow_dump_protocols;
 136
 137 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
 138 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
 139 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
 140
 141 bool ofputil_protocol_is_valid(enum ofputil_protocol);
 142 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
 143                                                bool enable);
 144 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
 145 enum ofputil_protocol ofputil_protocol_set_base(
 146     enum ofputil_protocol cur, enum ofputil_protocol new_base);
 147
 148 const char *ofputil_protocol_to_string(enum ofputil_protocol);
 149 char *ofputil_protocols_to_string(enum ofputil_protocol);
 150 enum ofputil_protocol ofputil_protocols_from_string(const char *);
 151
 152 void ofputil_format_version(struct ds *, enum ofp_version);
 153 void ofputil_format_version_name(struct ds *, enum ofp_version);
 154
 155 /* A bitmap of version numbers
 156  *
 157  * Bit offsets correspond to ofp_version numbers which in turn correspond to
 158  * wire-protocol numbers for Open Flow versions..  E.g. (1u << OFP11_VERSION)
 159  * is the mask for Open Flow 1.1.  If the bit for a version is set then it is
 160  * allowed, otherwise it is disallowed. */
 161
 162 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
 163 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
 164
 165 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
 166 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
 167
 168 /* Bitmap of OpenFlow versions that Open vSwitch supports. */
 169 #define OFPUTIL_SUPPORTED_VERSIONS \
 170     ((1u << OFP10_VERSION) | (1u << OFP12_VERSION) | (1u << OFP13_VERSION))
 171
 172 /* Bitmap of OpenFlow versions to enable by default (a subset of
 173  * OFPUTIL_SUPPORTED_VERSIONS). */
 174 #define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
 175
 176 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
 177
 178 const char *ofputil_version_to_string(enum ofp_version ofp_version);
 179 uint32_t ofputil_versions_from_string(const char *s);
 180 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
 181
 182 bool ofputil_decode_hello(const struct ofp_header *,
 183                           uint32_t *allowed_versions);
 184 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
 185
 186 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
 187                                            enum ofputil_protocol want,
 188                                            enum ofputil_protocol *next);
 189
 190 /* nx_flow_format */
 191 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
 192 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
 193 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
 194 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
 195
 196 /* Work with ofp10_match. */
 197 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
 198 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
 199                                     struct match *);
 200 void ofputil_normalize_match(struct match *);
 201 void ofputil_normalize_match_quiet(struct match *);
 202 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
 203
 204 /* Work with ofp11_match. */
 205 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
 206                                      uint16_t *padded_match_len);
 207 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
 208                                            struct match *);
 209 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
 210                             enum ofputil_protocol);
 211 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
 212 int ofputil_match_typical_len(enum ofputil_protocol);
 213
 214 /* dl_type translation between OpenFlow and 'struct flow' format. */
 215 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 216 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 217
 218 /* PACKET_IN. */
 219 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 220 int ofputil_packet_in_format_from_string(const char *);
 221 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 222 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
 223                                                  enum nx_packet_in_format);
 224
 225 /* NXT_FLOW_MOD_TABLE_ID extension. */
 226 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 227
 228 /* Protocol-independent flow_mod flags. */
 229 enum ofputil_flow_mod_flags {
 230     OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
 231     OFPUTIL_FF_CHECK_OVERLAP = 1 << 1, /* All versions. */
 232     OFPUTIL_FF_EMERG         = 1 << 2, /* OpenFlow 1.0 only. */
 233     OFPUTIL_FF_RESET_COUNTS  = 1 << 3, /* OpenFlow 1.2+. */
 234     OFPUTIL_FF_NO_PKT_COUNTS = 1 << 4, /* OpenFlow 1.3+. */
 235     OFPUTIL_FF_NO_BYT_COUNTS = 1 << 5  /* OpenFlow 1.3+. */
 236 };
 237
 238 /* Protocol-independent flow_mod.
 239  *
 240  * The handling of cookies across multiple versions of OpenFlow is a bit
 241  * confusing.  See DESIGN for the details. */
 242 struct ofputil_flow_mod {
 243     struct list list_node;    /* For queuing flow_mods. */
 244
 245     struct match match;
 246     unsigned int priority;
 247
 248     /* Cookie matching.  The flow_mod affects only flows that have cookies that
 249      * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
 250      *
 251      * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
 252     ovs_be64 cookie;         /* Cookie bits to match. */
 253     ovs_be64 cookie_mask;    /* 1-bit in each 'cookie' bit to match. */
 254
 255     /* Cookie changes.
 256      *
 257      * OFPFC_ADD uses 'new_cookie' as the new flow's cookie.  'new_cookie'
 258      * should not be UINT64_MAX.
 259      *
 260      * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
 261      *
 262      *   - If one or more matching flows exist and 'modify_cookie' is true,
 263      *     then the flow_mod changes the existing flows' cookies to
 264      *     'new_cookie'.  'new_cookie' should not be UINT64_MAX.
 265      *
 266      *   - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
 267      *     'cookie_mask' is 0, then the flow_mod adds a new flow with
 268      *     'new_cookie' as its cookie.
 269      */
 270     ovs_be64 new_cookie;     /* New cookie to install or UINT64_MAX. */
 271     bool modify_cookie;      /* Set cookie of existing flow to 'new_cookie'? */
 272
 273     uint8_t table_id;
 274     uint16_t command;
 275     uint16_t idle_timeout;
 276     uint16_t hard_timeout;
 277     uint32_t buffer_id;
 278     ofp_port_t out_port;
 279     uint32_t out_group;
 280     enum ofputil_flow_mod_flags flags;
 281     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
 282     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
 283 };
 284
 285 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 286                                     const struct ofp_header *,
 287                                     enum ofputil_protocol,
 288                                     struct ofpbuf *ofpacts);
 289 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 290                                        enum ofputil_protocol);
 291
 292 /* Flow stats or aggregate stats request, independent of protocol. */
 293 struct ofputil_flow_stats_request {
 294     bool aggregate;             /* Aggregate results? */
 295     struct match match;
 296     ovs_be64 cookie;
 297     ovs_be64 cookie_mask;
 298     ofp_port_t out_port;
 299     uint32_t out_group;
 300     uint8_t table_id;
 301 };
 302
 303 enum ofperr ofputil_decode_flow_stats_request(
 304     struct ofputil_flow_stats_request *, const struct ofp_header *);
 305 struct ofpbuf *ofputil_encode_flow_stats_request(
 306     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
 307
 308 /* Flow stats reply, independent of protocol. */
 309 struct ofputil_flow_stats {
 310     struct match match;
 311     ovs_be64 cookie;
 312     uint8_t table_id;
 313     uint32_t duration_sec;
 314     uint32_t duration_nsec;
 315     uint16_t priority;
 316     uint16_t idle_timeout;
 317     uint16_t hard_timeout;
 318     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 319     int hard_age;               /* Seconds since last change, -1 if unknown. */
 320     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 321     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 322     struct ofpact *ofpacts;
 323     size_t ofpacts_len;
 324     enum ofputil_flow_mod_flags flags;
 325 };
 326
 327 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 328                                     struct ofpbuf *msg,
 329                                     bool flow_age_extension,
 330                                     struct ofpbuf *ofpacts);
 331 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 332                                      struct list *replies);
 333
 334 /* Aggregate stats reply, independent of protocol. */
 335 struct ofputil_aggregate_stats {
 336     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 337     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 338     uint32_t flow_count;
 339 };
 340
 341 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 342     const struct ofputil_aggregate_stats *stats,
 343     const struct ofp_header *request);
 344 enum ofperr ofputil_decode_aggregate_stats_reply(
 345     struct ofputil_aggregate_stats *,
 346     const struct ofp_header *reply);
 347
 348 /* Flow removed message, independent of protocol. */
 349 struct ofputil_flow_removed {
 350     struct match match;
 351     uint16_t priority;
 352     ovs_be64 cookie;
 353     uint8_t reason;             /* One of OFPRR_*. */
 354     uint8_t table_id;           /* 255 if message didn't include table ID. */
 355     uint32_t duration_sec;
 356     uint32_t duration_nsec;
 357     uint16_t idle_timeout;
 358     uint16_t hard_timeout;
 359     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 360     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 361 };
 362
 363 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 364                                         const struct ofp_header *);
 365 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 366                                            enum ofputil_protocol);
 367
 368 /* Abstract packet-in message. */
 369 struct ofputil_packet_in {
 370     struct list list_node; /* For queueing packet_ins. */
 371
 372     const void *packet;
 373     size_t packet_len;
 374
 375     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
 376     uint16_t controller_id;              /* Controller ID to send to. */
 377     uint8_t table_id;
 378     ovs_be64 cookie;
 379
 380     uint32_t buffer_id;
 381     int send_len;
 382     uint16_t total_len;         /* Full length of frame. */
 383
 384     struct flow_metadata fmd;   /* Metadata at creation time. */
 385 };
 386
 387 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
 388                                      const struct ofp_header *);
 389 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 390                                         enum ofputil_protocol protocol,
 391                                         enum nx_packet_in_format);
 392
 393 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
 394 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
 395                                                char *reasonbuf,
 396                                                size_t bufsize);
 397 bool ofputil_packet_in_reason_from_string(const char *,
 398                                           enum ofp_packet_in_reason *);
 399
 400 /* Abstract packet-out message.
 401  *
 402  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
 403  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
 404 struct ofputil_packet_out {
 405     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 406     size_t packet_len;          /* Length of packet data in bytes. */
 407     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 408     ofp_port_t in_port;         /* Packet's input port. */
 409     struct ofpact *ofpacts;     /* Actions. */
 410     size_t ofpacts_len;         /* Size of ofpacts in bytes. */
 411 };
 412
 413 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 414                                       const struct ofp_header *,
 415                                       struct ofpbuf *ofpacts);
 416 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
 417                                          enum ofputil_protocol protocol);
 418
 419 enum ofputil_port_config {
 420     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
 421     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
 422     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
 423     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
 424     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
 425     /* OpenFlow 1.0 only. */
 426     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
 427     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 428     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 429     /* There are no OpenFlow 1.1-only bits. */
 430 };
 431
 432 enum ofputil_port_state {
 433     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
 434     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 435     /* OpenFlow 1.1 only. */
 436     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
 437     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
 438     /* OpenFlow 1.0 only. */
 439     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 440     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 441     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 442     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 443     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 444 };
 445
 446 /* Abstract ofp10_phy_port or ofp11_port. */
 447 struct ofputil_phy_port {
 448     ofp_port_t port_no;
 449     uint8_t hw_addr[OFP_ETH_ALEN];
 450     char name[OFP_MAX_PORT_NAME_LEN];
 451     enum ofputil_port_config config;
 452     enum ofputil_port_state state;
 453
 454     /* NETDEV_F_* feature bitmasks. */
 455     enum netdev_features curr;       /* Current features. */
 456     enum netdev_features advertised; /* Features advertised by the port. */
 457     enum netdev_features supported;  /* Features supported by the port. */
 458     enum netdev_features peer;       /* Features advertised by peer. */
 459
 460     /* Speed. */
 461     uint32_t curr_speed;        /* Current speed, in kbps. */
 462     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
 463 };
 464
 465 enum ofputil_capabilities {
 466     /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
 467     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 468     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 469     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
 470     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 471     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 472
 473     /* OpenFlow 1.0 and 1.1 share this capability. */
 474     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
 475
 476     /* OpenFlow 1.0 only. */
 477     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
 478
 479     /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
 480     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
 481
 482     /* OpenFlow 1.2 and 1.3 share this capability */
 483     OFPUTIL_C_PORT_BLOCKED   = 1 << 8,  /* Switch will block looping ports */
 484 };
 485
 486 enum ofputil_action_bitmap {
 487     OFPUTIL_A_OUTPUT         = 1 << 0,
 488     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
 489     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
 490     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
 491     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
 492     OFPUTIL_A_SET_DL_DST     = 1 << 5,
 493     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
 494     OFPUTIL_A_SET_NW_DST     = 1 << 7,
 495     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
 496     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
 497     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
 498     OFPUTIL_A_SET_TP_DST     = 1 << 11,
 499     OFPUTIL_A_ENQUEUE        = 1 << 12,
 500     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
 501     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
 502     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
 503     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
 504     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
 505     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
 506     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
 507     OFPUTIL_A_POP_VLAN       = 1 << 20,
 508     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
 509     OFPUTIL_A_POP_MPLS       = 1 << 22,
 510     OFPUTIL_A_SET_QUEUE      = 1 << 23,
 511     OFPUTIL_A_GROUP          = 1 << 24,
 512     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
 513     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
 514     OFPUTIL_A_SET_FIELD      = 1 << 27,
 515 };
 516
 517 /* Abstract ofp_switch_features. */
 518 struct ofputil_switch_features {
 519     uint64_t datapath_id;       /* Datapath unique ID. */
 520     uint32_t n_buffers;         /* Max packets buffered at once. */
 521     uint8_t n_tables;           /* Number of tables supported by datapath. */
 522     uint8_t auxiliary_id;       /* Identify auxiliary connections */
 523     enum ofputil_capabilities capabilities;
 524     enum ofputil_action_bitmap actions;
 525 };
 526
 527 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
 528                                            struct ofputil_switch_features *,
 529                                            struct ofpbuf *);
 530
 531 struct ofpbuf *ofputil_encode_switch_features(
 532     const struct ofputil_switch_features *, enum ofputil_protocol,
 533     ovs_be32 xid);
 534 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
 535                                       struct ofpbuf *);
 536 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
 537
 538 /* phy_port helper functions. */
 539 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
 540                           struct ofputil_phy_port *);
 541 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
 542
 543 /* Abstract ofp_port_status. */
 544 struct ofputil_port_status {
 545     enum ofp_port_reason reason;
 546     struct ofputil_phy_port desc;
 547 };
 548
 549 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
 550                                        struct ofputil_port_status *);
 551 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
 552                                           enum ofputil_protocol);
 553
 554 /* Abstract ofp_port_mod. */
 555 struct ofputil_port_mod {
 556     ofp_port_t port_no;
 557     uint8_t hw_addr[OFP_ETH_ALEN];
 558     enum ofputil_port_config config;
 559     enum ofputil_port_config mask;
 560     enum netdev_features advertise;
 561 };
 562
 563 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
 564                                     struct ofputil_port_mod *);
 565 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
 566                                        enum ofputil_protocol);
 567
 568 /* Meter band configuration for all supported band types. */
 569 struct ofputil_meter_band {
 570     uint16_t type;
 571     uint8_t prec_level;         /* Non-zero if type == OFPMBT_DSCP_REMARK. */
 572     uint32_t rate;
 573     uint32_t burst_size;
 574 };
 575
 576 struct ofputil_meter_band_stats {
 577     uint64_t packet_count;
 578     uint64_t byte_count;
 579 };
 580
 581 struct ofputil_meter_config {
 582     uint32_t meter_id;
 583     uint16_t flags;
 584     uint16_t n_bands;
 585     struct ofputil_meter_band *bands;
 586 };
 587
 588 /* Abstract ofp_meter_mod. */
 589 struct ofputil_meter_mod {
 590     uint16_t command;
 591     struct ofputil_meter_config meter;
 592 };
 593
 594 struct ofputil_meter_stats {
 595     uint32_t meter_id;
 596     uint32_t flow_count;
 597     uint64_t packet_in_count;
 598     uint64_t byte_in_count;
 599     uint32_t duration_sec;
 600     uint32_t duration_nsec;
 601     uint16_t n_bands;
 602     struct ofputil_meter_band_stats *bands;
 603 };
 604
 605 struct ofputil_meter_features {
 606     uint32_t max_meters;        /* Maximum number of meters. */
 607     uint32_t band_types;        /* Can support max 32 band types. */
 608     uint32_t capabilities;      /* Supported flags. */
 609     uint8_t  max_bands;
 610     uint8_t  max_color;
 611 };
 612
 613 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
 614                                      struct ofputil_meter_mod *,
 615                                      struct ofpbuf *bands);
 616 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
 617                                         const struct ofputil_meter_mod *);
 618
 619 void ofputil_decode_meter_features(const struct ofp_header *,
 620                                    struct ofputil_meter_features *);
 621 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
 622                                                    ofputil_meter_features *,
 623                                                    const struct ofp_header *
 624                                                    request);
 625 void ofputil_decode_meter_request(const struct ofp_header *,
 626                                   uint32_t *meter_id);
 627
 628 void ofputil_append_meter_config(struct list *replies,
 629                                  const struct ofputil_meter_config *);
 630
 631 void ofputil_append_meter_stats(struct list *replies,
 632                                 const struct ofputil_meter_stats *);
 633
 634 enum ofputil_meter_request_type {
 635     OFPUTIL_METER_FEATURES,
 636     OFPUTIL_METER_CONFIG,
 637     OFPUTIL_METER_STATS
 638 };
 639
 640 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
 641                                             enum ofputil_meter_request_type,
 642                                             uint32_t meter_id);
 643
 644 int ofputil_decode_meter_stats(struct ofpbuf *,
 645                                struct ofputil_meter_stats *,
 646                                struct ofpbuf *bands);
 647
 648 int ofputil_decode_meter_config(struct ofpbuf *,
 649                                 struct ofputil_meter_config *,
 650                                 struct ofpbuf *bands);
 651
 652 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
 653 typedef struct { uint32_t uint32; } ofproto_meter_id;
 654
 655 /* Abstract ofp_role_request and reply. */
 656 struct ofputil_role_request {
 657     enum ofp12_controller_role role;
 658     bool have_generation_id;
 659     uint64_t generation_id;
 660 };
 661
 662 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
 663                                         struct ofputil_role_request *);
 664 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
 665                                          const struct ofputil_role_request *);
 666
 667 /* Abstract table stats.
 668  *
 669  * For now we use ofp12_table_stats as a superset of the other protocol
 670  * versions' table stats. */
 671
 672 struct ofpbuf *ofputil_encode_table_stats_reply(
 673     const struct ofp12_table_stats[], int n,
 674     const struct ofp_header *request);
 675
 676 /* Abstract nx_flow_monitor_request. */
 677 struct ofputil_flow_monitor_request {
 678     uint32_t id;
 679     enum nx_flow_monitor_flags flags;
 680     ofp_port_t out_port;
 681     uint8_t table_id;
 682     struct match match;
 683 };
 684
 685 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
 686                                         struct ofpbuf *msg);
 687 void ofputil_append_flow_monitor_request(
 688     const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
 689
 690 /* Abstract nx_flow_update. */
 691 struct ofputil_flow_update {
 692     enum nx_flow_update_event event;
 693
 694     /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
 695     enum ofp_flow_removed_reason reason;
 696     uint16_t idle_timeout;
 697     uint16_t hard_timeout;
 698     uint8_t table_id;
 699     ovs_be64 cookie;
 700     struct match *match;
 701     uint16_t priority;
 702     struct ofpact *ofpacts;
 703     size_t ofpacts_len;
 704
 705     /* Used only for NXFME_ABBREV. */
 706     ovs_be32 xid;
 707 };
 708
 709 int ofputil_decode_flow_update(struct ofputil_flow_update *,
 710                                struct ofpbuf *msg, struct ofpbuf *ofpacts);
 711 void ofputil_start_flow_update(struct list *replies);
 712 void ofputil_append_flow_update(const struct ofputil_flow_update *,
 713                                 struct list *replies);
 714
 715 /* Abstract nx_flow_monitor_cancel. */
 716 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
 717 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
 718
 719 /* Encoding OpenFlow stats messages. */
 720 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
 721                                           const struct ofputil_phy_port *pp,
 722                                           struct list *replies);
 723
 724 /* Encoding simple OpenFlow messages. */
 725 struct ofpbuf *make_echo_request(enum ofp_version);
 726 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 727
 728 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
 729
 730 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 731 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 732
 733 \f
 734 /* Actions. */
 735
 736 /* The type of an action.
 737  *
 738  * For each implemented OFPAT10_* and NXAST_* action type, there is a
 739  * corresponding constant prefixed with OFPUTIL_, e.g.:
 740  *
 741  * OFPUTIL_OFPAT10_OUTPUT
 742  * OFPUTIL_OFPAT10_SET_VLAN_VID
 743  * OFPUTIL_OFPAT10_SET_VLAN_PCP
 744  * OFPUTIL_OFPAT10_STRIP_VLAN
 745  * OFPUTIL_OFPAT10_SET_DL_SRC
 746  * OFPUTIL_OFPAT10_SET_DL_DST
 747  * OFPUTIL_OFPAT10_SET_NW_SRC
 748  * OFPUTIL_OFPAT10_SET_NW_DST
 749  * OFPUTIL_OFPAT10_SET_NW_TOS
 750  * OFPUTIL_OFPAT10_SET_TP_SRC
 751  * OFPUTIL_OFPAT10_SET_TP_DST
 752  * OFPUTIL_OFPAT10_ENQUEUE
 753  * OFPUTIL_NXAST_RESUBMIT
 754  * OFPUTIL_NXAST_SET_TUNNEL
 755  * OFPUTIL_NXAST_SET_METADATA
 756  * OFPUTIL_NXAST_SET_QUEUE
 757  * OFPUTIL_NXAST_POP_QUEUE
 758  * OFPUTIL_NXAST_REG_MOVE
 759  * OFPUTIL_NXAST_REG_LOAD
 760  * OFPUTIL_NXAST_NOTE
 761  * OFPUTIL_NXAST_SET_TUNNEL64
 762  * OFPUTIL_NXAST_MULTIPATH
 763  * OFPUTIL_NXAST_BUNDLE
 764  * OFPUTIL_NXAST_BUNDLE_LOAD
 765  * OFPUTIL_NXAST_RESUBMIT_TABLE
 766  * OFPUTIL_NXAST_OUTPUT_REG
 767  * OFPUTIL_NXAST_LEARN
 768  * OFPUTIL_NXAST_DEC_TTL
 769  * OFPUTIL_NXAST_FIN_TIMEOUT
 770  *
 771  * (The above list helps developers who want to "grep" for these definitions.)
 772  */
 773 enum OVS_PACKED_ENUM ofputil_action_code {
 774     OFPUTIL_ACTION_INVALID,
 775 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 776 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 777 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   OFPUTIL_##ENUM,
 778 #include "ofp-util.def"
 779 };
 780
 781 /* The number of values of "enum ofputil_action_code". */
 782 enum {
 783 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
 784 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 785 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   + 1
 786     OFPUTIL_N_ACTIONS = 1
 787 #include "ofp-util.def"
 788 };
 789
 790 int ofputil_action_code_from_name(const char *);
 791
 792 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 793
 794 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 795  * struct <STRUCT>, this defines two functions:
 796  *
 797  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 798  *
 799  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 800  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 801  *     variable length, the length used and cleared is that of struct <STRUCT>.
 802  *
 803  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 804  *
 805  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 806  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 807  */
 808 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
 809     void ofputil_init_##ENUM(struct STRUCT *);          \
 810     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 811 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
 812     void ofputil_init_##ENUM(struct STRUCT *);          \
 813     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 814 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 815     void ofputil_init_##ENUM(struct STRUCT *);          \
 816     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 817 #include "ofp-util.def"
 818
 819 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 820
 821 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 822
 823 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 824                                  union ofp_action **, size_t *);
 825
 826 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 827                            const union ofp_action *b, size_t n_b);
 828 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 829
 830 /* Handy utility for parsing flows and actions. */
 831 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 832
 833 struct ofputil_port_stats {
 834     ofp_port_t port_no;
 835     struct netdev_stats stats;
 836     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
 837     uint32_t duration_nsec;
 838 };
 839
 840 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
 841                                                  ofp_port_t port);
 842 void ofputil_append_port_stat(struct list *replies,
 843                               const struct ofputil_port_stats *ops);
 844 size_t ofputil_count_port_stats(const struct ofp_header *);
 845 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
 846 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
 847                                               ofp_port_t *ofp10_port);
 848
 849 struct ofputil_queue_stats_request {
 850     ofp_port_t port_no;           /* OFPP_ANY means "all ports". */
 851     uint32_t queue_id;
 852 };
 853
 854 enum ofperr
 855 ofputil_decode_queue_stats_request(const struct ofp_header *request,
 856                                    struct ofputil_queue_stats_request *oqsr);
 857 struct ofpbuf *
 858 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
 859                                    const struct ofputil_queue_stats_request *oqsr);
 860
 861 struct ofputil_queue_stats {
 862     ofp_port_t port_no;
 863     uint32_t queue_id;
 864
 865     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
 866     uint64_t tx_bytes;
 867     uint64_t tx_packets;
 868     uint64_t tx_errors;
 869
 870     /* UINT32_MAX if unknown. */
 871     uint32_t duration_sec;
 872     uint32_t duration_nsec;
 873 };
 874
 875 size_t ofputil_count_queue_stats(const struct ofp_header *);
 876 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
 877 void ofputil_append_queue_stat(struct list *replies,
 878                                const struct ofputil_queue_stats *oqs);
 879
 880 /* Bucket for use in groups. */
 881 struct ofputil_bucket {
 882     struct list list_node;
 883     uint16_t weight;            /* Relative weight, for "select" groups. */
 884     ofp_port_t watch_port;      /* Port whose state affects whether this bucket
 885                                  * is live. Only required for fast failover
 886                                  * groups. */
 887     uint32_t watch_group;       /* Group whose state affects whether this
 888                                  * bucket is live. Only required for fast
 889                                  * failover groups. */
 890     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
 891     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
 892 };
 893
 894 /* Protocol-independent group_mod. */
 895 struct ofputil_group_mod {
 896     uint16_t command;             /* One of OFPGC11_*. */
 897     uint8_t type;                 /* One of OFPGT11_*. */
 898     uint32_t group_id;            /* Group identifier. */
 899     struct list buckets;          /* Contains "struct ofputil_bucket"s. */
 900 };
 901
 902 struct bucket_counter {
 903     uint64_t packet_count;   /* Number of packets processed by bucket. */
 904     uint64_t byte_count;     /* Number of bytes processed by bucket. */
 905 };
 906
 907 /* Group stats reply, independent of protocol. */
 908 struct ofputil_group_stats {
 909     uint32_t group_id;    /* Group identifier. */
 910     uint32_t ref_count;
 911     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 912     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 913     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
 914     uint32_t duration_nsec;
 915     uint32_t n_buckets;
 916     struct bucket_counter bucket_stats[16];
 917 };
 918
 919 /* Group features reply, independent of protocol. */
 920 struct ofputil_group_features {
 921     uint32_t  types;           /* Bitmap of OFPGT_* values supported. */
 922     uint32_t  capabilities;    /* Bitmap of OFPGFC12_* capability supported. */
 923     uint32_t  max_groups[4];   /* Maximum number of groups for each type. */
 924     uint32_t  actions[4];      /* Bitmaps of OFPAT_* that are supported. */
 925 };
 926
 927 /* Group desc reply, independent of protocol. */
 928 struct ofputil_group_desc {
 929     uint8_t type;               /* One of OFPGT_*. */
 930     uint32_t group_id;          /* Group identifier. */
 931     struct list buckets;        /* Contains "struct ofputil_bucket"s. */
 932 };
 933
 934 void ofputil_bucket_list_destroy(struct list *buckets);
 935
 936 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
 937                                                   uint32_t group_id);
 938 enum ofperr ofputil_decode_group_stats_request(
 939     const struct ofp_header *request, uint32_t *group_id);
 940 void ofputil_append_group_stats(struct list *replies,
 941                                 const struct ofputil_group_stats *);
 942 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
 943 struct ofpbuf *ofputil_encode_group_features_reply(
 944     const struct ofputil_group_features *, const struct ofp_header *request);
 945 void ofputil_decode_group_features_reply(const struct ofp_header *,
 946                                          struct ofputil_group_features *);
 947 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
 948                                         const struct ofputil_group_mod *gm);
 949
 950 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
 951                                      struct ofputil_group_mod *);
 952
 953 int ofputil_decode_group_stats_reply(struct ofpbuf *,
 954                                      struct ofputil_group_stats *);
 955
 956 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
 957                                     struct ofpbuf *);
 958
 959 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
 960                                      struct list *buckets,
 961                                      struct list *replies);
 962 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version);
 963
 964 #endif /* ofp-util.h */