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 "flow.h"
  26 #include "netdev.h"
  27 #include "openflow/nicira-ext.h"
  28 #include "openvswitch/types.h"
  29
  30 struct cls_rule;
  31 struct ofpbuf;
  32
  33 /* Basic decoding and length validation of OpenFlow messages. */
  34 enum ofputil_msg_code {
  35     OFPUTIL_MSG_INVALID,
  36
  37     /* OFPT_* messages. */
  38     OFPUTIL_OFPT_HELLO,
  39     OFPUTIL_OFPT_ERROR,
  40     OFPUTIL_OFPT_ECHO_REQUEST,
  41     OFPUTIL_OFPT_ECHO_REPLY,
  42     OFPUTIL_OFPT_FEATURES_REQUEST,
  43     OFPUTIL_OFPT_FEATURES_REPLY,
  44     OFPUTIL_OFPT_GET_CONFIG_REQUEST,
  45     OFPUTIL_OFPT_GET_CONFIG_REPLY,
  46     OFPUTIL_OFPT_SET_CONFIG,
  47     OFPUTIL_OFPT_PACKET_IN,
  48     OFPUTIL_OFPT_FLOW_REMOVED,
  49     OFPUTIL_OFPT_PORT_STATUS,
  50     OFPUTIL_OFPT_PACKET_OUT,
  51     OFPUTIL_OFPT_FLOW_MOD,
  52     OFPUTIL_OFPT_PORT_MOD,
  53     OFPUTIL_OFPT_BARRIER_REQUEST,
  54     OFPUTIL_OFPT_BARRIER_REPLY,
  55     OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
  56     OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
  57
  58     /* OFPST_* stat requests. */
  59     OFPUTIL_OFPST_DESC_REQUEST,
  60     OFPUTIL_OFPST_FLOW_REQUEST,
  61     OFPUTIL_OFPST_AGGREGATE_REQUEST,
  62     OFPUTIL_OFPST_TABLE_REQUEST,
  63     OFPUTIL_OFPST_PORT_REQUEST,
  64     OFPUTIL_OFPST_QUEUE_REQUEST,
  65     OFPUTIL_OFPST_PORT_DESC_REQUEST,
  66
  67     /* OFPST_* stat replies. */
  68     OFPUTIL_OFPST_DESC_REPLY,
  69     OFPUTIL_OFPST_FLOW_REPLY,
  70     OFPUTIL_OFPST_QUEUE_REPLY,
  71     OFPUTIL_OFPST_PORT_REPLY,
  72     OFPUTIL_OFPST_TABLE_REPLY,
  73     OFPUTIL_OFPST_AGGREGATE_REPLY,
  74     OFPUTIL_OFPST_PORT_DESC_REPLY,
  75
  76     /* NXT_* messages. */
  77     OFPUTIL_NXT_ROLE_REQUEST,
  78     OFPUTIL_NXT_ROLE_REPLY,
  79     OFPUTIL_NXT_SET_FLOW_FORMAT,
  80     OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
  81     OFPUTIL_NXT_FLOW_MOD,
  82     OFPUTIL_NXT_FLOW_REMOVED,
  83     OFPUTIL_NXT_SET_PACKET_IN_FORMAT,
  84     OFPUTIL_NXT_PACKET_IN,
  85     OFPUTIL_NXT_FLOW_AGE,
  86     OFPUTIL_NXT_SET_ASYNC_CONFIG,
  87     OFPUTIL_NXT_SET_CONTROLLER_ID,
  88
  89     /* NXST_* stat requests. */
  90     OFPUTIL_NXST_FLOW_REQUEST,
  91     OFPUTIL_NXST_AGGREGATE_REQUEST,
  92
  93     /* NXST_* stat replies. */
  94     OFPUTIL_NXST_FLOW_REPLY,
  95     OFPUTIL_NXST_AGGREGATE_REPLY
  96 };
  97
  98 struct ofputil_msg_type;
  99 enum ofperr ofputil_decode_msg_type(const struct ofp_header *,
 100                                     const struct ofputil_msg_type **);
 101 enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *,
 102                                             size_t length,
 103                                             const struct ofputil_msg_type **);
 104 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
 105 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
 106
 107 /* Port numbers. */
 108 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port);
 109 ovs_be32 ofputil_port_to_ofp11(uint16_t ofp10_port);
 110
 111 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
 112 bool ofputil_port_from_string(const char *, uint16_t *port);
 113 void ofputil_format_port(uint16_t port, struct ds *);
 114
 115 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
 116  * and from IP bitmasks. */
 117 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
 118 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
 119
 120 /* Protocols.
 121  *
 122  * These are arranged from most portable to least portable, or alternatively
 123  * from least powerful to most powerful.  Formats earlier on the list are more
 124  * likely to be understood for the purpose of making requests, but formats
 125  * later on the list are more likely to accurately describe a flow within a
 126  * switch.
 127  *
 128  * On any given OpenFlow connection, a single protocol is in effect at any
 129  * given time.  These values use separate bits only because that makes it easy
 130  * to test whether a particular protocol is within a given set of protocols and
 131  * to implement set union and intersection.
 132  */
 133 enum ofputil_protocol {
 134     /* OpenFlow 1.0-based protocols. */
 135     OFPUTIL_P_OF10     = 1 << 0, /* OpenFlow 1.0 flow format. */
 136     OFPUTIL_P_OF10_TID = 1 << 1, /* OF1.0 + flow_mod_table_id extension. */
 137 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10 | OFPUTIL_P_OF10_TID)
 138
 139     /* OpenFlow 1.0 with NXM-based flow formats. */
 140     OFPUTIL_P_NXM      = 1 << 2, /* Nicira extended match. */
 141     OFPUTIL_P_NXM_TID  = 1 << 3, /* NXM + flow_mod_table_id extension. */
 142 #define OFPUTIL_P_NXM_ANY (OFPUTIL_P_NXM | OFPUTIL_P_NXM_TID)
 143
 144     /* All protocols. */
 145 #define OFPUTIL_P_ANY (OFPUTIL_P_OF10_ANY | OFPUTIL_P_NXM_ANY)
 146
 147     /* Protocols in which a specific table may be specified in flow_mods. */
 148 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_TID | OFPUTIL_P_NXM_TID)
 149 };
 150
 151 /* Protocols to use for flow dumps, from most to least preferred. */
 152 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
 153 extern size_t ofputil_n_flow_dump_protocols;
 154
 155 enum ofputil_protocol ofputil_protocol_from_ofp_version(int version);
 156 uint8_t ofputil_protocol_to_ofp_version(enum ofputil_protocol);
 157
 158 bool ofputil_protocol_is_valid(enum ofputil_protocol);
 159 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
 160                                                bool enable);
 161 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
 162 enum ofputil_protocol ofputil_protocol_set_base(
 163     enum ofputil_protocol cur, enum ofputil_protocol new_base);
 164
 165 const char *ofputil_protocol_to_string(enum ofputil_protocol);
 166 char *ofputil_protocols_to_string(enum ofputil_protocol);
 167 enum ofputil_protocol ofputil_protocols_from_string(const char *);
 168 enum ofputil_protocol ofputil_usable_protocols(const struct cls_rule *);
 169
 170 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
 171                                            enum ofputil_protocol want,
 172                                            enum ofputil_protocol *next);
 173
 174 /* nx_flow_format */
 175 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
 176 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
 177 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
 178 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
 179
 180 /* Work with OpenFlow 1.0 ofp_match. */
 181 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
 182 void ofputil_cls_rule_from_match(const struct ofp_match *,
 183                                  unsigned int priority, struct cls_rule *);
 184 void ofputil_normalize_rule(struct cls_rule *);
 185 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
 186
 187 /* dl_type translation between OpenFlow and 'struct flow' format. */
 188 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 189 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 190
 191 /* PACKET_IN. */
 192 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 193 int ofputil_packet_in_format_from_string(const char *);
 194 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 195 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
 196
 197 /* NXT_FLOW_MOD_TABLE_ID extension. */
 198 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 199
 200 /* Protocol-independent flow_mod. */
 201 struct ofputil_flow_mod {
 202     struct cls_rule cr;
 203     ovs_be64 cookie;
 204     ovs_be64 cookie_mask;
 205     uint8_t table_id;
 206     uint16_t command;
 207     uint16_t idle_timeout;
 208     uint16_t hard_timeout;
 209     uint32_t buffer_id;
 210     uint16_t out_port;
 211     uint16_t flags;
 212     union ofp_action *actions;
 213     size_t n_actions;
 214 };
 215
 216 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 217                                     const struct ofp_header *,
 218                                     enum ofputil_protocol);
 219 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 220                                        enum ofputil_protocol);
 221
 222 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
 223     const struct ofputil_flow_mod *fms, size_t n_fms);
 224
 225 /* Flow stats or aggregate stats request, independent of protocol. */
 226 struct ofputil_flow_stats_request {
 227     bool aggregate;             /* Aggregate results? */
 228     struct cls_rule match;
 229     ovs_be64 cookie;
 230     ovs_be64 cookie_mask;
 231     uint16_t out_port;
 232     uint8_t table_id;
 233 };
 234
 235 enum ofperr ofputil_decode_flow_stats_request(
 236     struct ofputil_flow_stats_request *, const struct ofp_header *);
 237 struct ofpbuf *ofputil_encode_flow_stats_request(
 238     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
 239 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
 240     const struct ofputil_flow_stats_request *);
 241
 242 /* Flow stats reply, independent of protocol. */
 243 struct ofputil_flow_stats {
 244     struct cls_rule rule;
 245     ovs_be64 cookie;
 246     uint8_t table_id;
 247     uint32_t duration_sec;
 248     uint32_t duration_nsec;
 249     uint16_t idle_timeout;
 250     uint16_t hard_timeout;
 251     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 252     int hard_age;               /* Seconds since last change, -1 if unknown. */
 253     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 254     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 255     union ofp_action *actions;
 256     size_t n_actions;
 257 };
 258
 259 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 260                                     struct ofpbuf *msg,
 261                                     bool flow_age_extension);
 262 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 263                                      struct list *replies);
 264
 265 /* Aggregate stats reply, independent of protocol. */
 266 struct ofputil_aggregate_stats {
 267     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 268     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 269     uint32_t flow_count;
 270 };
 271
 272 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 273     const struct ofputil_aggregate_stats *stats,
 274     const struct ofp_stats_msg *request);
 275
 276 /* Flow removed message, independent of protocol. */
 277 struct ofputil_flow_removed {
 278     struct cls_rule rule;
 279     ovs_be64 cookie;
 280     uint8_t reason;             /* One of OFPRR_*. */
 281     uint32_t duration_sec;
 282     uint32_t duration_nsec;
 283     uint16_t idle_timeout;
 284     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 285     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 286 };
 287
 288 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 289                                         const struct ofp_header *);
 290 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 291                                            enum ofputil_protocol);
 292
 293 /* Abstract packet-in message. */
 294 struct ofputil_packet_in {
 295     const void *packet;
 296     size_t packet_len;
 297
 298     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
 299     uint16_t controller_id;              /* Controller ID to send to. */
 300     uint8_t table_id;
 301     ovs_be64 cookie;
 302
 303     uint32_t buffer_id;
 304     int send_len;
 305     uint16_t total_len;         /* Full length of frame. */
 306
 307     struct flow_metadata fmd;   /* Metadata at creation time. */
 308 };
 309
 310 int ofputil_decode_packet_in(struct ofputil_packet_in *,
 311                              const struct ofp_header *);
 312 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 313                                         enum nx_packet_in_format);
 314
 315 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
 316 bool ofputil_packet_in_reason_from_string(const char *,
 317                                           enum ofp_packet_in_reason *);
 318
 319 /* Abstract packet-out message.
 320  *
 321  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
 322  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
 323 struct ofputil_packet_out {
 324     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 325     size_t packet_len;          /* Length of packet data in bytes. */
 326     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 327     uint16_t in_port;           /* Packet's input port. */
 328     union ofp_action *actions;  /* Actions. */
 329     size_t n_actions;           /* Number of elements in 'actions' array. */
 330 };
 331
 332 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 333                                       const struct ofp_packet_out *);
 334 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
 335
 336 enum ofputil_port_config {
 337     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
 338     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
 339     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
 340     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
 341     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
 342     /* OpenFlow 1.0 only. */
 343     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
 344     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 345     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 346     /* There are no OpenFlow 1.1-only bits. */
 347 };
 348
 349 enum ofputil_port_state {
 350     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
 351     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 352     /* OpenFlow 1.1 only. */
 353     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
 354     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
 355     /* OpenFlow 1.0 only. */
 356     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 357     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 358     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 359     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 360     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 361 };
 362
 363 /* Abstract ofp10_phy_port or ofp11_port. */
 364 struct ofputil_phy_port {
 365     uint16_t port_no;
 366     uint8_t hw_addr[OFP_ETH_ALEN];
 367     char name[OFP_MAX_PORT_NAME_LEN];
 368     enum ofputil_port_config config;
 369     enum ofputil_port_state state;
 370
 371     /* NETDEV_F_* feature bitmasks. */
 372     enum netdev_features curr;       /* Current features. */
 373     enum netdev_features advertised; /* Features advertised by the port. */
 374     enum netdev_features supported;  /* Features supported by the port. */
 375     enum netdev_features peer;       /* Features advertised by peer. */
 376
 377     /* Speed. */
 378     uint32_t curr_speed;        /* Current speed, in kbps. */
 379     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
 380 };
 381
 382 enum ofputil_capabilities {
 383     /* OpenFlow 1.0 and 1.1 share these values for these capabilities. */
 384     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 385     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 386     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
 387     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 388     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 389     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
 390
 391     /* OpenFlow 1.0 only. */
 392     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
 393
 394     /* OpenFlow 1.1 only. */
 395     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
 396 };
 397
 398 enum ofputil_action_bitmap {
 399     OFPUTIL_A_OUTPUT         = 1 << 0,
 400     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
 401     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
 402     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
 403     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
 404     OFPUTIL_A_SET_DL_DST     = 1 << 5,
 405     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
 406     OFPUTIL_A_SET_NW_DST     = 1 << 7,
 407     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
 408     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
 409     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
 410     OFPUTIL_A_SET_TP_DST     = 1 << 11,
 411     OFPUTIL_A_ENQUEUE        = 1 << 12,
 412     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
 413     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
 414     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
 415     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
 416     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
 417     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
 418     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
 419     OFPUTIL_A_POP_VLAN       = 1 << 20,
 420     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
 421     OFPUTIL_A_POP_MPLS       = 1 << 22,
 422     OFPUTIL_A_SET_QUEUE      = 1 << 23,
 423     OFPUTIL_A_GROUP          = 1 << 24,
 424     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
 425     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
 426 };
 427
 428 /* Abstract ofp_switch_features. */
 429 struct ofputil_switch_features {
 430     uint64_t datapath_id;       /* Datapath unique ID. */
 431     uint32_t n_buffers;         /* Max packets buffered at once. */
 432     uint8_t n_tables;           /* Number of tables supported by datapath. */
 433     enum ofputil_capabilities capabilities;
 434     enum ofputil_action_bitmap actions;
 435 };
 436
 437 enum ofperr ofputil_decode_switch_features(const struct ofp_switch_features *,
 438                                            struct ofputil_switch_features *,
 439                                            struct ofpbuf *);
 440
 441 struct ofpbuf *ofputil_encode_switch_features(
 442     const struct ofputil_switch_features *, enum ofputil_protocol,
 443     ovs_be32 xid);
 444 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
 445                                       struct ofpbuf *);
 446
 447 /* phy_port helper functions. */
 448 int ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *,
 449                           struct ofputil_phy_port *);
 450 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
 451
 452 /* Abstract ofp_port_status. */
 453 struct ofputil_port_status {
 454     enum ofp_port_reason reason;
 455     struct ofputil_phy_port desc;
 456 };
 457
 458 enum ofperr ofputil_decode_port_status(const struct ofp_port_status *,
 459                                        struct ofputil_port_status *);
 460 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
 461                                           enum ofputil_protocol);
 462
 463 /* Abstract ofp_port_mod. */
 464 struct ofputil_port_mod {
 465     uint16_t port_no;
 466     uint8_t hw_addr[OFP_ETH_ALEN];
 467     enum ofputil_port_config config;
 468     enum ofputil_port_config mask;
 469     enum netdev_features advertise;
 470 };
 471
 472 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
 473                                     struct ofputil_port_mod *);
 474 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
 475                                        enum ofputil_protocol);
 476
 477 /* OpenFlow protocol utility functions. */
 478 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 479 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 480
 481 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 482                         ovs_be32 xid, struct ofpbuf **);
 483 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 484                      struct ofpbuf **);
 485
 486 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 487 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 488                        struct ofpbuf *);
 489
 490 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 491 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 492                     struct ofpbuf *);
 493
 494 void update_openflow_length(struct ofpbuf *);
 495
 496 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
 497                                  uint32_t subtype, struct ofpbuf **);
 498 void *ofputil_make_stats_reply(size_t openflow_len,
 499                                const struct ofp_stats_msg *request,
 500                                struct ofpbuf **);
 501
 502 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
 503                                struct list *);
 504 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
 505 void *ofputil_append_stats_reply(size_t len, struct list *);
 506
 507 void ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
 508                                           const struct ofputil_phy_port *pp,
 509                                           struct list *replies);
 510
 511 const void *ofputil_stats_body(const struct ofp_header *);
 512 size_t ofputil_stats_body_len(const struct ofp_header *);
 513
 514 const void *ofputil_nxstats_body(const struct ofp_header *);
 515 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 516
 517 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 518                              size_t actions_len);
 519 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 520                              uint16_t max_idle, size_t actions_len);
 521 struct ofpbuf *make_del_flow(const struct cls_rule *);
 522 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 523                                     uint32_t buffer_id, uint16_t out_port,
 524                                     uint16_t max_idle);
 525 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 526                               uint8_t reason,
 527                               const struct ofpbuf *payload, int max_send_len);
 528 struct ofpbuf *make_echo_request(void);
 529 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 530
 531 struct ofpbuf *ofputil_encode_barrier_request(void);
 532
 533 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 534 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 535
 536 \f
 537 /* Actions. */
 538
 539 /* The type of an action.
 540  *
 541  * For each implemented OFPAT10_* and NXAST_* action type, there is a
 542  * corresponding constant prefixed with OFPUTIL_, e.g.:
 543  *
 544  * OFPUTIL_OFPAT10_OUTPUT
 545  * OFPUTIL_OFPAT10_SET_VLAN_VID
 546  * OFPUTIL_OFPAT10_SET_VLAN_PCP
 547  * OFPUTIL_OFPAT10_STRIP_VLAN
 548  * OFPUTIL_OFPAT10_SET_DL_SRC
 549  * OFPUTIL_OFPAT10_SET_DL_DST
 550  * OFPUTIL_OFPAT10_SET_NW_SRC
 551  * OFPUTIL_OFPAT10_SET_NW_DST
 552  * OFPUTIL_OFPAT10_SET_NW_TOS
 553  * OFPUTIL_OFPAT10_SET_TP_SRC
 554  * OFPUTIL_OFPAT10_SET_TP_DST
 555  * OFPUTIL_OFPAT10_ENQUEUE
 556  * OFPUTIL_NXAST_RESUBMIT
 557  * OFPUTIL_NXAST_SET_TUNNEL
 558  * OFPUTIL_NXAST_SET_QUEUE
 559  * OFPUTIL_NXAST_POP_QUEUE
 560  * OFPUTIL_NXAST_REG_MOVE
 561  * OFPUTIL_NXAST_REG_LOAD
 562  * OFPUTIL_NXAST_NOTE
 563  * OFPUTIL_NXAST_SET_TUNNEL64
 564  * OFPUTIL_NXAST_MULTIPATH
 565  * OFPUTIL_NXAST_AUTOPATH
 566  * OFPUTIL_NXAST_BUNDLE
 567  * OFPUTIL_NXAST_BUNDLE_LOAD
 568  * OFPUTIL_NXAST_RESUBMIT_TABLE
 569  * OFPUTIL_NXAST_OUTPUT_REG
 570  * OFPUTIL_NXAST_LEARN
 571  * OFPUTIL_NXAST_DEC_TTL
 572  * OFPUTIL_NXAST_FIN_TIMEOUT
 573  *
 574  * (The above list helps developers who want to "grep" for these definitions.)
 575  */
 576 enum ofputil_action_code {
 577 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 578 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 579 #include "ofp-util.def"
 580 };
 581
 582 /* The number of values of "enum ofputil_action_code". */
 583 enum {
 584 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
 585 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 586     OFPUTIL_N_ACTIONS = 0
 587 #include "ofp-util.def"
 588 };
 589
 590 int ofputil_decode_action(const union ofp_action *);
 591 enum ofputil_action_code ofputil_decode_action_unsafe(
 592     const union ofp_action *);
 593
 594 int ofputil_action_code_from_name(const char *);
 595
 596 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 597
 598 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 599  * struct <STRUCT>, this defines two functions:
 600  *
 601  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 602  *
 603  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 604  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 605  *     variable length, the length used and cleared is that of struct <STRUCT>.
 606  *
 607  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 608  *
 609  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 610  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 611  */
 612 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
 613     void ofputil_init_##ENUM(struct STRUCT *);          \
 614     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 615 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 616     void ofputil_init_##ENUM(struct STRUCT *);          \
 617     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 618 #include "ofp-util.def"
 619
 620 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 621
 622 static inline union ofp_action *
 623 ofputil_action_next(const union ofp_action *a)
 624 {
 625     return ((union ofp_action *) (void *)
 626             ((uint8_t *) a + ntohs(a->header.len)));
 627 }
 628
 629 static inline bool
 630 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
 631 {
 632     uint16_t len = ntohs(a->header.len);
 633     return (!(len % OFP_ACTION_ALIGN)
 634             && len >= sizeof *a
 635             && len / sizeof *a <= n_actions);
 636 }
 637
 638 /* This macro is careful to check for actions with bad lengths. */
 639 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
 640     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 641          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
 642          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 643           (ITER) = ofputil_action_next(ITER)))
 644
 645 /* This macro does not check for actions with bad lengths.  It should only be
 646  * used with actions from trusted sources or with actions that have already
 647  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
 648 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
 649     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 650          (LEFT) > 0;                                                    \
 651          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 652           (ITER) = ofputil_action_next(ITER)))
 653
 654 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
 655                              const struct flow *, int max_ports);
 656 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 657
 658 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 659                                  union ofp_action **, size_t *);
 660
 661 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 662                            const union ofp_action *b, size_t n_b);
 663 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 664
 665 /* Handy utility for parsing flows and actions. */
 666 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 667
 668 #endif /* ofp-util.h */