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