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 OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
 116  * to 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 ofp10_match. */
 181 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
 182 void ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *,
 183                                        unsigned int priority,
 184                                        struct cls_rule *);
 185 void ofputil_normalize_rule(struct cls_rule *);
 186 void ofputil_cls_rule_to_ofp10_match(const struct cls_rule *,
 187                                      struct ofp10_match *);
 188
 189 /* dl_type translation between OpenFlow and 'struct flow' format. */
 190 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 191 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 192
 193 /* PACKET_IN. */
 194 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 195 int ofputil_packet_in_format_from_string(const char *);
 196 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 197 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
 198
 199 /* NXT_FLOW_MOD_TABLE_ID extension. */
 200 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 201
 202 /* Protocol-independent flow_mod.
 203  *
 204  * The handling of cookies across multiple versions of OpenFlow is a bit
 205  * confusing.  A full description of Open vSwitch's cookie handling is
 206  * in the DESIGN file.  The following table shows the expected values of
 207  * the cookie-related fields for the different flow_mod commands in
 208  * OpenFlow 1.0 ("OF10") and NXM.  "<used>" and "-" indicate a value
 209  * that may be populated and an ignored field, respectively.
 210  *
 211  *               cookie  cookie_mask  new_cookie
 212  *               ======  ===========  ==========
 213  * OF10 Add        -          0         <used>
 214  * OF10 Modify     -          0         <used>
 215  * OF10 Delete     -          0           -
 216  * NXM Add         -          0         <used>
 217  * NXM Modify    <used>     <used>      <used>
 218  * NXM Delete    <used>     <used>        -
 219  */
 220 struct ofputil_flow_mod {
 221     struct cls_rule cr;
 222     ovs_be64 cookie;         /* Cookie bits to match. */
 223     ovs_be64 cookie_mask;    /* 1-bit in each 'cookie' bit to match. */
 224     ovs_be64 new_cookie;     /* New cookie to install or -1. */
 225     uint8_t table_id;
 226     uint16_t command;
 227     uint16_t idle_timeout;
 228     uint16_t hard_timeout;
 229     uint32_t buffer_id;
 230     uint16_t out_port;
 231     uint16_t flags;
 232     union ofp_action *actions;
 233     size_t n_actions;
 234 };
 235
 236 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 237                                     const struct ofp_header *,
 238                                     enum ofputil_protocol);
 239 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 240                                        enum ofputil_protocol);
 241
 242 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
 243     const struct ofputil_flow_mod *fms, size_t n_fms);
 244
 245 /* Flow stats or aggregate stats request, independent of protocol. */
 246 struct ofputil_flow_stats_request {
 247     bool aggregate;             /* Aggregate results? */
 248     struct cls_rule match;
 249     ovs_be64 cookie;
 250     ovs_be64 cookie_mask;
 251     uint16_t out_port;
 252     uint8_t table_id;
 253 };
 254
 255 enum ofperr ofputil_decode_flow_stats_request(
 256     struct ofputil_flow_stats_request *, const struct ofp_header *);
 257 struct ofpbuf *ofputil_encode_flow_stats_request(
 258     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
 259 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
 260     const struct ofputil_flow_stats_request *);
 261
 262 /* Flow stats reply, independent of protocol. */
 263 struct ofputil_flow_stats {
 264     struct cls_rule rule;
 265     ovs_be64 cookie;
 266     uint8_t table_id;
 267     uint32_t duration_sec;
 268     uint32_t duration_nsec;
 269     uint16_t idle_timeout;
 270     uint16_t hard_timeout;
 271     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 272     int hard_age;               /* Seconds since last change, -1 if unknown. */
 273     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 274     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 275     union ofp_action *actions;
 276     size_t n_actions;
 277 };
 278
 279 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 280                                     struct ofpbuf *msg,
 281                                     bool flow_age_extension);
 282 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 283                                      struct list *replies);
 284
 285 /* Aggregate stats reply, independent of protocol. */
 286 struct ofputil_aggregate_stats {
 287     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 288     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 289     uint32_t flow_count;
 290 };
 291
 292 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 293     const struct ofputil_aggregate_stats *stats,
 294     const struct ofp_stats_msg *request);
 295
 296 /* Flow removed message, independent of protocol. */
 297 struct ofputil_flow_removed {
 298     struct cls_rule rule;
 299     ovs_be64 cookie;
 300     uint8_t reason;             /* One of OFPRR_*. */
 301     uint32_t duration_sec;
 302     uint32_t duration_nsec;
 303     uint16_t idle_timeout;
 304     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 305     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 306 };
 307
 308 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 309                                         const struct ofp_header *);
 310 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 311                                            enum ofputil_protocol);
 312
 313 /* Abstract packet-in message. */
 314 struct ofputil_packet_in {
 315     const void *packet;
 316     size_t packet_len;
 317
 318     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
 319     uint16_t controller_id;              /* Controller ID to send to. */
 320     uint8_t table_id;
 321     ovs_be64 cookie;
 322
 323     uint32_t buffer_id;
 324     int send_len;
 325     uint16_t total_len;         /* Full length of frame. */
 326
 327     struct flow_metadata fmd;   /* Metadata at creation time. */
 328 };
 329
 330 int ofputil_decode_packet_in(struct ofputil_packet_in *,
 331                              const struct ofp_header *);
 332 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 333                                         enum nx_packet_in_format);
 334
 335 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
 336 bool ofputil_packet_in_reason_from_string(const char *,
 337                                           enum ofp_packet_in_reason *);
 338
 339 /* Abstract packet-out message.
 340  *
 341  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
 342  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
 343 struct ofputil_packet_out {
 344     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 345     size_t packet_len;          /* Length of packet data in bytes. */
 346     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 347     uint16_t in_port;           /* Packet's input port. */
 348     union ofp_action *actions;  /* Actions. */
 349     size_t n_actions;           /* Number of elements in 'actions' array. */
 350 };
 351
 352 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 353                                       const struct ofp_packet_out *);
 354 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
 355
 356 enum ofputil_port_config {
 357     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
 358     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
 359     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
 360     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
 361     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
 362     /* OpenFlow 1.0 only. */
 363     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
 364     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 365     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 366     /* There are no OpenFlow 1.1-only bits. */
 367 };
 368
 369 enum ofputil_port_state {
 370     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
 371     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 372     /* OpenFlow 1.1 only. */
 373     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
 374     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
 375     /* OpenFlow 1.0 only. */
 376     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 377     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 378     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 379     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 380     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 381 };
 382
 383 /* Abstract ofp10_phy_port or ofp11_port. */
 384 struct ofputil_phy_port {
 385     uint16_t port_no;
 386     uint8_t hw_addr[OFP_ETH_ALEN];
 387     char name[OFP_MAX_PORT_NAME_LEN];
 388     enum ofputil_port_config config;
 389     enum ofputil_port_state state;
 390
 391     /* NETDEV_F_* feature bitmasks. */
 392     enum netdev_features curr;       /* Current features. */
 393     enum netdev_features advertised; /* Features advertised by the port. */
 394     enum netdev_features supported;  /* Features supported by the port. */
 395     enum netdev_features peer;       /* Features advertised by peer. */
 396
 397     /* Speed. */
 398     uint32_t curr_speed;        /* Current speed, in kbps. */
 399     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
 400 };
 401
 402 enum ofputil_capabilities {
 403     /* OpenFlow 1.0 and 1.1 share these values for these capabilities. */
 404     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 405     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 406     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
 407     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 408     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 409     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
 410
 411     /* OpenFlow 1.0 only. */
 412     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
 413
 414     /* OpenFlow 1.1 only. */
 415     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
 416 };
 417
 418 enum ofputil_action_bitmap {
 419     OFPUTIL_A_OUTPUT         = 1 << 0,
 420     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
 421     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
 422     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
 423     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
 424     OFPUTIL_A_SET_DL_DST     = 1 << 5,
 425     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
 426     OFPUTIL_A_SET_NW_DST     = 1 << 7,
 427     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
 428     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
 429     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
 430     OFPUTIL_A_SET_TP_DST     = 1 << 11,
 431     OFPUTIL_A_ENQUEUE        = 1 << 12,
 432     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
 433     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
 434     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
 435     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
 436     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
 437     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
 438     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
 439     OFPUTIL_A_POP_VLAN       = 1 << 20,
 440     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
 441     OFPUTIL_A_POP_MPLS       = 1 << 22,
 442     OFPUTIL_A_SET_QUEUE      = 1 << 23,
 443     OFPUTIL_A_GROUP          = 1 << 24,
 444     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
 445     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
 446 };
 447
 448 /* Abstract ofp_switch_features. */
 449 struct ofputil_switch_features {
 450     uint64_t datapath_id;       /* Datapath unique ID. */
 451     uint32_t n_buffers;         /* Max packets buffered at once. */
 452     uint8_t n_tables;           /* Number of tables supported by datapath. */
 453     enum ofputil_capabilities capabilities;
 454     enum ofputil_action_bitmap actions;
 455 };
 456
 457 enum ofperr ofputil_decode_switch_features(const struct ofp_switch_features *,
 458                                            struct ofputil_switch_features *,
 459                                            struct ofpbuf *);
 460
 461 struct ofpbuf *ofputil_encode_switch_features(
 462     const struct ofputil_switch_features *, enum ofputil_protocol,
 463     ovs_be32 xid);
 464 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
 465                                       struct ofpbuf *);
 466 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
 467
 468 /* phy_port helper functions. */
 469 int ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *,
 470                           struct ofputil_phy_port *);
 471 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
 472
 473 /* Abstract ofp_port_status. */
 474 struct ofputil_port_status {
 475     enum ofp_port_reason reason;
 476     struct ofputil_phy_port desc;
 477 };
 478
 479 enum ofperr ofputil_decode_port_status(const struct ofp_port_status *,
 480                                        struct ofputil_port_status *);
 481 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
 482                                           enum ofputil_protocol);
 483
 484 /* Abstract ofp_port_mod. */
 485 struct ofputil_port_mod {
 486     uint16_t port_no;
 487     uint8_t hw_addr[OFP_ETH_ALEN];
 488     enum ofputil_port_config config;
 489     enum ofputil_port_config mask;
 490     enum netdev_features advertise;
 491 };
 492
 493 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
 494                                     struct ofputil_port_mod *);
 495 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
 496                                        enum ofputil_protocol);
 497
 498 /* OpenFlow protocol utility functions. */
 499 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 500 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 501
 502 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 503                         ovs_be32 xid, struct ofpbuf **);
 504 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 505                      struct ofpbuf **);
 506
 507 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 508 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 509                        struct ofpbuf *);
 510
 511 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 512 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 513                     struct ofpbuf *);
 514
 515 void update_openflow_length(struct ofpbuf *);
 516
 517 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
 518                                  uint32_t subtype, struct ofpbuf **);
 519 void *ofputil_make_stats_reply(size_t openflow_len,
 520                                const struct ofp_stats_msg *request,
 521                                struct ofpbuf **);
 522
 523 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
 524                                struct list *);
 525 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
 526 void *ofputil_append_stats_reply(size_t len, struct list *);
 527
 528 void ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
 529                                           const struct ofputil_phy_port *pp,
 530                                           struct list *replies);
 531
 532 const void *ofputil_stats_body(const struct ofp_header *);
 533 size_t ofputil_stats_body_len(const struct ofp_header *);
 534
 535 const void *ofputil_nxstats_body(const struct ofp_header *);
 536 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 537
 538 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 539                              size_t actions_len);
 540 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 541                              uint16_t max_idle, size_t actions_len);
 542 struct ofpbuf *make_del_flow(const struct cls_rule *);
 543 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 544                                     uint32_t buffer_id, uint16_t out_port,
 545                                     uint16_t max_idle);
 546 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 547                               uint8_t reason,
 548                               const struct ofpbuf *payload, int max_send_len);
 549 struct ofpbuf *make_echo_request(void);
 550 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 551
 552 struct ofpbuf *ofputil_encode_barrier_request(void);
 553
 554 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 555 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 556
 557 \f
 558 /* Actions. */
 559
 560 /* The type of an action.
 561  *
 562  * For each implemented OFPAT10_* and NXAST_* action type, there is a
 563  * corresponding constant prefixed with OFPUTIL_, e.g.:
 564  *
 565  * OFPUTIL_OFPAT10_OUTPUT
 566  * OFPUTIL_OFPAT10_SET_VLAN_VID
 567  * OFPUTIL_OFPAT10_SET_VLAN_PCP
 568  * OFPUTIL_OFPAT10_STRIP_VLAN
 569  * OFPUTIL_OFPAT10_SET_DL_SRC
 570  * OFPUTIL_OFPAT10_SET_DL_DST
 571  * OFPUTIL_OFPAT10_SET_NW_SRC
 572  * OFPUTIL_OFPAT10_SET_NW_DST
 573  * OFPUTIL_OFPAT10_SET_NW_TOS
 574  * OFPUTIL_OFPAT10_SET_TP_SRC
 575  * OFPUTIL_OFPAT10_SET_TP_DST
 576  * OFPUTIL_OFPAT10_ENQUEUE
 577  * OFPUTIL_NXAST_RESUBMIT
 578  * OFPUTIL_NXAST_SET_TUNNEL
 579  * OFPUTIL_NXAST_SET_QUEUE
 580  * OFPUTIL_NXAST_POP_QUEUE
 581  * OFPUTIL_NXAST_REG_MOVE
 582  * OFPUTIL_NXAST_REG_LOAD
 583  * OFPUTIL_NXAST_NOTE
 584  * OFPUTIL_NXAST_SET_TUNNEL64
 585  * OFPUTIL_NXAST_MULTIPATH
 586  * OFPUTIL_NXAST_AUTOPATH
 587  * OFPUTIL_NXAST_BUNDLE
 588  * OFPUTIL_NXAST_BUNDLE_LOAD
 589  * OFPUTIL_NXAST_RESUBMIT_TABLE
 590  * OFPUTIL_NXAST_OUTPUT_REG
 591  * OFPUTIL_NXAST_LEARN
 592  * OFPUTIL_NXAST_DEC_TTL
 593  * OFPUTIL_NXAST_FIN_TIMEOUT
 594  *
 595  * (The above list helps developers who want to "grep" for these definitions.)
 596  */
 597 enum ofputil_action_code {
 598 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 599 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 600 #include "ofp-util.def"
 601 };
 602
 603 /* The number of values of "enum ofputil_action_code". */
 604 enum {
 605 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
 606 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 607     OFPUTIL_N_ACTIONS = 0
 608 #include "ofp-util.def"
 609 };
 610
 611 int ofputil_decode_action(const union ofp_action *);
 612 enum ofputil_action_code ofputil_decode_action_unsafe(
 613     const union ofp_action *);
 614
 615 int ofputil_action_code_from_name(const char *);
 616
 617 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 618
 619 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 620  * struct <STRUCT>, this defines two functions:
 621  *
 622  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 623  *
 624  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 625  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 626  *     variable length, the length used and cleared is that of struct <STRUCT>.
 627  *
 628  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 629  *
 630  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 631  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 632  */
 633 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
 634     void ofputil_init_##ENUM(struct STRUCT *);          \
 635     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 636 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 637     void ofputil_init_##ENUM(struct STRUCT *);          \
 638     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 639 #include "ofp-util.def"
 640
 641 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 642
 643 static inline union ofp_action *
 644 ofputil_action_next(const union ofp_action *a)
 645 {
 646     return ((union ofp_action *) (void *)
 647             ((uint8_t *) a + ntohs(a->header.len)));
 648 }
 649
 650 static inline bool
 651 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
 652 {
 653     uint16_t len = ntohs(a->header.len);
 654     return (!(len % OFP_ACTION_ALIGN)
 655             && len >= sizeof *a
 656             && len / sizeof *a <= n_actions);
 657 }
 658
 659 /* This macro is careful to check for actions with bad lengths. */
 660 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
 661     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 662          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
 663          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 664           (ITER) = ofputil_action_next(ITER)))
 665
 666 /* This macro does not check for actions with bad lengths.  It should only be
 667  * used with actions from trusted sources or with actions that have already
 668  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
 669 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
 670     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 671          (LEFT) > 0;                                                    \
 672          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 673           (ITER) = ofputil_action_next(ITER)))
 674
 675 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
 676                              const struct flow *, int max_ports);
 677 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 678
 679 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 680                                  union ofp_action **, size_t *);
 681
 682 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 683                            const union ofp_action *b, size_t n_b);
 684 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 685
 686 /* Handy utility for parsing flows and actions. */
 687 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 688
 689 #endif /* ofp-util.h */