lib/ofp-util.h

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