include/openflow/nicira-ext.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks
   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 OPENFLOW_NICIRA_EXT_H
  18 #define OPENFLOW_NICIRA_EXT_H 1
  19
  20 #include "openflow/openflow.h"
  21 #include "openvswitch/types.h"
  22
  23 /* The following vendor extensions, proposed by Nicira Networks, are not yet
  24  * standardized, so they are not included in openflow.h.  Some of them may be
  25  * suitable for standardization; others we never expect to standardize. */
  26
  27 #define NX_VENDOR_ID 0x00002320
  28 \f
  29 /* Nicira vendor-specific error messages extension.
  30  *
  31  * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
  32  * are specific to each type).  It does not have any provision for
  33  * vendor-specific error codes, and it does not even provide "generic" error
  34  * codes that can apply to problems not anticipated by the OpenFlow
  35  * specification authors.
  36  *
  37  * This extension attempts to address the problem by adding a generic "error
  38  * vendor extension".  The extension works as follows: use NXET_VENDOR as type
  39  * and NXVC_VENDOR_CODE as code, followed by struct nx_vendor_error with
  40  * vendor-specific details, followed by at least 64 bytes of the failed
  41  * request.
  42  *
  43  * It would be better to have a type-specific vendor extension, e.g. so that
  44  * OFPET_BAD_ACTION could be used with vendor-specific code values.  But
  45  * OFPET_BAD_ACTION and most other standardized types already specify that
  46  * their 'data' values are (the start of) the OpenFlow message being replied
  47  * to, so there is no room to insert a vendor ID.
  48  *
  49  * Currently this extension is only implemented by Open vSwitch, but it seems
  50  * like a reasonable candidate for future standardization.
  51  */
  52
  53 /* This is a random number to avoid accidental collision with any other
  54  * vendor's extension. */
  55 #define NXET_VENDOR 0xb0c2
  56
  57 /* ofp_error msg 'code' values for NXET_VENDOR. */
  58 enum nx_vendor_code {
  59     NXVC_VENDOR_ERROR           /* 'data' contains struct nx_vendor_error. */
  60 };
  61
  62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
  63 struct nx_vendor_error {
  64     ovs_be32 vendor;            /* Vendor ID as in struct ofp_vendor_header. */
  65     ovs_be16 type;              /* Vendor-defined type. */
  66     ovs_be16 code;              /* Vendor-defined subtype. */
  67     /* Followed by at least the first 64 bytes of the failed request. */
  68 };
  69 \f
  70 /* Specific Nicira extension error numbers.
  71  *
  72  * These are the "code" values used in nx_vendor_error.  So far, the "type"
  73  * values in nx_vendor_error are the same as those in ofp_error_msg.  That is,
  74  * at Nicira so far we've only needed additional vendor-specific 'code' values,
  75  * so we're using the existing 'type' values to avoid having to invent new ones
  76  * that duplicate the current ones' meanings. */
  77
  78 /* Additional "code" values for OFPET_BAD_REQUEST. */
  79 enum {
  80 /* Nicira Extended Match (NXM) errors. */
  81
  82     /* Generic error code used when there is an error in an NXM sent to the
  83      * switch.  The switch may use one of the more specific error codes below,
  84      * if there is an appropriate one, to simplify debugging, but it is not
  85      * required to do so. */
  86     NXBRC_NXM_INVALID = 0x100,
  87
  88     /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or
  89      * nxm_length or both, is invalid or not implemented. */
  90     NXBRC_NXM_BAD_TYPE = 0x101,
  91
  92     /* Invalid nxm_value. */
  93     NXBRC_NXM_BAD_VALUE = 0x102,
  94
  95     /* Invalid nxm_mask. */
  96     NXBRC_NXM_BAD_MASK = 0x103,
  97
  98     /* A prerequisite was not met. */
  99     NXBRC_NXM_BAD_PREREQ = 0x104,
 100
 101     /* A given nxm_type was specified more than once. */
 102     NXBRC_NXM_DUP_TYPE = 0x105
 103 };
 104
 105 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
 106 enum {
 107     /* Generic hardware error. */
 108     NXFMFC_HARDWARE = 0x100,
 109
 110     /* A nonexistent table ID was specified in the "command" field of struct
 111      * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled.
 112      * (This extension is not yet implemented on this branch of Open
 113      * vSwitch.) */
 114     NXFMFC_BAD_TABLE_ID = 0x101
 115 };
 116 \f
 117 /* Nicira vendor requests and replies. */
 118
 119 /* Header for Nicira vendor requests and replies. */
 120 struct nicira_header {
 121     struct ofp_header header;
 122     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 123     ovs_be32 subtype;           /* One of NXT_* below. */
 124 };
 125 OFP_ASSERT(sizeof(struct nicira_header) == 16);
 126
 127 /* Values for the 'subtype' member of struct nicira_header. */
 128 enum nicira_type {
 129     /* Switch status request.  The request body is an ASCII string that
 130      * specifies a prefix of the key names to include in the output; if it is
 131      * the null string, then all key-value pairs are included. */
 132     NXT_STATUS_REQUEST,
 133
 134     /* Switch status reply.  The reply body is an ASCII string of key-value
 135      * pairs in the form "key=value\n". */
 136     NXT_STATUS_REPLY,
 137
 138     /* No longer used. */
 139     NXT_ACT_SET_CONFIG__OBSOLETE,
 140     NXT_ACT_GET_CONFIG__OBSOLETE,
 141     NXT_COMMAND_REQUEST__OBSOLETE,
 142     NXT_COMMAND_REPLY__OBSOLETE,
 143     NXT_FLOW_END_CONFIG__OBSOLETE,
 144     NXT_FLOW_END__OBSOLETE,
 145     NXT_MGMT__OBSOLETE,
 146
 147     /* Use the high 32 bits of the cookie field as the tunnel ID in the flow
 148      * match. */
 149     NXT_TUN_ID_FROM_COOKIE,
 150
 151     /* Controller role support.  The request body is struct nx_role_request.
 152      * The reply echos the request. */
 153     NXT_ROLE_REQUEST,
 154     NXT_ROLE_REPLY,
 155
 156     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 157     NXT_SET_FLOW_FORMAT,        /* Set flow format. */
 158     NXT_FLOW_MOD,               /* Analogous to OFPT_FLOW_MOD. */
 159     NXT_FLOW_REMOVED            /* Analogous to OFPT_FLOW_REMOVED. */
 160 };
 161
 162 /* Header for Nicira vendor stats request and reply messages. */
 163 struct nicira_stats_msg {
 164     struct ofp_header header;   /* OFPT_STATS_REQUEST or OFPT_STATS_REPLY. */
 165     ovs_be16 type;              /* OFPST_VENDOR. */
 166     ovs_be16 flags;             /* OFPSF_{REQ,REPLY}_*. */
 167     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 168     ovs_be32 subtype;           /* One of NXST_* below. */
 169     uint8_t pad[4];             /* Align to 64-bits. */
 170 };
 171 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
 172
 173 /* Values for the 'subtype' member of struct nicira_stats_msg. */
 174 enum nicira_stats_type {
 175     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 176     NXST_FLOW,                  /* Analogous to OFPST_FLOW. */
 177     NXST_AGGREGATE              /* Analogous to OFPST_AGGREGATE. */
 178 };
 179
 180 /* NXT_TUN_ID_FROM_COOKIE request. */
 181 struct nxt_tun_id_cookie {
 182     struct ofp_header header;
 183     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 184     ovs_be32 subtype;           /* NXT_TUN_ID_FROM_COOKIE */
 185     uint8_t set;                /* Nonzero to enable, zero to disable. */
 186     uint8_t pad[7];
 187 };
 188 OFP_ASSERT(sizeof(struct nxt_tun_id_cookie) == 24);
 189
 190 /* Configures the "role" of the sending controller.  The default role is:
 191  *
 192  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
 193  *      OpenFlow features.
 194  *
 195  * The other possible roles are a related pair:
 196  *
 197  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
 198  *      be at most one Master controller at a time: when a controller
 199  *      configures itself as Master, any existing Master is demoted to the
 200  *      Slave role.
 201  *
 202  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
 203  *      OpenFlow features.  In particular attempts to modify the flow table
 204  *      will be rejected with an OFPBRC_EPERM error.
 205  *
 206  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
 207  *      messages, but they do receive OFPT_PORT_STATUS messages.
 208  */
 209 struct nx_role_request {
 210     struct nicira_header nxh;
 211     ovs_be32 role;              /* One of NX_ROLE_*. */
 212 };
 213
 214 enum nx_role {
 215     NX_ROLE_OTHER,              /* Default role, full access. */
 216     NX_ROLE_MASTER,             /* Full access, at most one. */
 217     NX_ROLE_SLAVE               /* Read-only access. */
 218 };
 219 \f
 220 /* Nicira vendor flow actions. */
 221
 222 enum nx_action_subtype {
 223     NXAST_SNAT__OBSOLETE,       /* No longer used. */
 224     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
 225     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
 226     NXAST_DROP_SPOOFED_ARP,     /* struct nx_action_drop_spoofed_arp */
 227     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
 228     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
 229     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
 230     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
 231     NXAST_NOTE,                 /* struct nx_action_note */
 232     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
 233 };
 234
 235 /* Header for Nicira-defined actions. */
 236 struct nx_action_header {
 237     ovs_be16 type;                  /* OFPAT_VENDOR. */
 238     ovs_be16 len;                   /* Length is 16. */
 239     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 240     ovs_be16 subtype;               /* NXAST_*. */
 241     uint8_t pad[6];
 242 };
 243 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
 244
 245 /* Action structure for NXAST_RESUBMIT.
 246  *
 247  * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
 248  * modified from the original lookup:
 249  *
 250  *    - The 'in_port' member of struct nx_action_resubmit is used as the flow's
 251  *      in_port.
 252  *
 253  *    - If NXAST_RESUBMIT is preceded by actions that affect the flow
 254  *      (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
 255  *      values.
 256  *
 257  * Following the lookup, the original in_port is restored.
 258  *
 259  * If the modified flow matched in the flow table, then the corresponding
 260  * actions are executed.  Afterward, actions following NXAST_RESUBMIT in the
 261  * original set of actions, if any, are executed; any changes made to the
 262  * packet (e.g. changes to VLAN) by secondary actions persist when those
 263  * actions are executed, although the original in_port is restored.
 264  *
 265  * NXAST_RESUBMIT may be used any number of times within a set of actions.
 266  *
 267  * NXAST_RESUBMIT may nest to an implementation-defined depth.  Beyond this
 268  * implementation-defined depth, further NXAST_RESUBMIT actions are simply
 269  * ignored.  (Open vSwitch 1.0.1 and earlier did not support recursion.)
 270  */
 271 struct nx_action_resubmit {
 272     ovs_be16 type;                  /* OFPAT_VENDOR. */
 273     ovs_be16 len;                   /* Length is 16. */
 274     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 275     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
 276     ovs_be16 in_port;               /* New in_port for checking flow table. */
 277     uint8_t pad[4];
 278 };
 279 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
 280
 281 /* Action structure for NXAST_SET_TUNNEL.
 282  *
 283  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
 284  * bits of the tunnel ID are set to 0. */
 285 struct nx_action_set_tunnel {
 286     ovs_be16 type;                  /* OFPAT_VENDOR. */
 287     ovs_be16 len;                   /* Length is 16. */
 288     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 289     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
 290     uint8_t pad[2];
 291     ovs_be32 tun_id;                /* Tunnel ID. */
 292 };
 293 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
 294
 295 /* Action structure for NXAST_SET_TUNNEL64.
 296  *
 297  * Sets the encapsulating tunnel ID to a 64-bit value. */
 298 struct nx_action_set_tunnel64 {
 299     ovs_be16 type;                  /* OFPAT_VENDOR. */
 300     ovs_be16 len;                   /* Length is 16. */
 301     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 302     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
 303     uint8_t pad[6];
 304     ovs_be64 tun_id;                /* Tunnel ID. */
 305 };
 306 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
 307
 308 /* Action structure for NXAST_DROP_SPOOFED_ARP.
 309  *
 310  * Stops processing further actions, if the packet being processed is an
 311  * Ethernet+IPv4 ARP packet for which the source Ethernet address inside the
 312  * ARP packet differs from the source Ethernet address in the Ethernet header.
 313  *
 314  * This is useful because OpenFlow does not provide a way to match on the
 315  * Ethernet addresses inside ARP packets, so there is no other way to drop
 316  * spoofed ARPs other than sending every ARP packet to a controller. */
 317 struct nx_action_drop_spoofed_arp {
 318     ovs_be16 type;                  /* OFPAT_VENDOR. */
 319     ovs_be16 len;                   /* Length is 16. */
 320     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 321     ovs_be16 subtype;               /* NXAST_DROP_SPOOFED_ARP. */
 322     uint8_t pad[6];
 323 };
 324 OFP_ASSERT(sizeof(struct nx_action_drop_spoofed_arp) == 16);
 325
 326 /* Action structure for NXAST_SET_QUEUE.
 327  *
 328  * Set the queue that should be used when packets are output.  This is similar
 329  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
 330  * an argument.  This allows the queue to be defined before the port is
 331  * known. */
 332 struct nx_action_set_queue {
 333     ovs_be16 type;                  /* OFPAT_VENDOR. */
 334     ovs_be16 len;                   /* Length is 16. */
 335     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 336     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
 337     uint8_t pad[2];
 338     ovs_be32 queue_id;              /* Where to enqueue packets. */
 339 };
 340 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
 341
 342 /* Action structure for NXAST_POP_QUEUE.
 343  *
 344  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
 345  * were used.  Only the original queue can be restored this way; no stack is
 346  * maintained. */
 347 struct nx_action_pop_queue {
 348     ovs_be16 type;                  /* OFPAT_VENDOR. */
 349     ovs_be16 len;                   /* Length is 16. */
 350     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 351     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
 352     uint8_t pad[6];
 353 };
 354 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
 355
 356 /* Action structure for NXAST_REG_MOVE.
 357  *
 358  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
 359  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
 360  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
 361  * the next most significant bit, and so on.
 362  *
 363  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
 364  * sense to use nxm_hasmask=1 because the action does not do any kind of
 365  * matching; it uses the actual value of a field.)
 366  *
 367  * The following nxm_header values are potentially acceptable as 'src':
 368  *
 369  *   - NXM_OF_IN_PORT
 370  *   - NXM_OF_ETH_DST
 371  *   - NXM_OF_ETH_SRC
 372  *   - NXM_OF_ETH_TYPE
 373  *   - NXM_OF_VLAN_TCI
 374  *   - NXM_OF_IP_TOS
 375  *   - NXM_OF_IP_PROTO
 376  *   - NXM_OF_IP_SRC
 377  *   - NXM_OF_IP_DST
 378  *   - NXM_OF_TCP_SRC
 379  *   - NXM_OF_TCP_DST
 380  *   - NXM_OF_UDP_SRC
 381  *   - NXM_OF_UDP_DST
 382  *   - NXM_OF_ICMP_TYPE
 383  *   - NXM_OF_ICMP_CODE
 384  *   - NXM_OF_ARP_OP
 385  *   - NXM_OF_ARP_SPA
 386  *   - NXM_OF_ARP_TPA
 387  *   - NXM_NX_TUN_ID
 388  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 389  *
 390  * The following nxm_header values are potentially acceptable as 'dst':
 391  *
 392  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 393  *
 394  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
 395  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
 396  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
 397  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
 398  *     to the field's new value (with the CFI bit masked out).
 399  *
 400  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
 401  *     packet's next tunnel encapsulation.
 402  *
 403  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
 404  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
 405  * used only if the flow's nx_match includes an nxm_entry that specifies
 406  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
 407  *
 408  * The switch will reject actions for which src_ofs+n_bits is greater than the
 409  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
 410  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 411  */
 412 struct nx_action_reg_move {
 413     ovs_be16 type;                  /* OFPAT_VENDOR. */
 414     ovs_be16 len;                   /* Length is 16. */
 415     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 416     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
 417     ovs_be16 n_bits;                /* Number of bits. */
 418     ovs_be16 src_ofs;               /* Starting bit offset in source. */
 419     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
 420     ovs_be32 src;                   /* Source register. */
 421     ovs_be32 dst;                   /* Destination register. */
 422 };
 423 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
 424
 425 /* Action structure for NXAST_REG_LOAD.
 426  *
 427  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
 428  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
 429  * starts at 0 for the least-significant bit, 1 for the next most significant
 430  * bit, and so on.
 431  *
 432  * 'dst' is an nxm_header with nxm_hasmask=0.  It must be one of the following:
 433  *
 434  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 435  *
 436  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
 437  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
 438  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
 439  * also stored as one less than its true value:
 440  *
 441  *  15                           6 5                0
 442  * +------------------------------+------------------+
 443  * |              ofs             |    n_bits - 1    |
 444  * +------------------------------+------------------+
 445  *
 446  * The switch will reject actions for which ofs+n_bits is greater than the
 447  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
 448  * greater are set to 1, with error type OFPET_BAD_ACTION, code
 449  * OFPBAC_BAD_ARGUMENT.
 450  */
 451 struct nx_action_reg_load {
 452     ovs_be16 type;                  /* OFPAT_VENDOR. */
 453     ovs_be16 len;                   /* Length is 16. */
 454     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 455     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
 456     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
 457     ovs_be32 dst;                   /* Destination register. */
 458     ovs_be64 value;                 /* Immediate value. */
 459 };
 460 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
 461
 462 /* Action structure for NXAST_NOTE.
 463  *
 464  * This action has no effect.  It is variable length.  The switch does not
 465  * attempt to interpret the user-defined 'note' data in any way.  A controller
 466  * can use this action to attach arbitrary metadata to a flow.
 467  *
 468  * This action might go away in the future.
 469  */
 470 struct nx_action_note {
 471     ovs_be16 type;                  /* OFPAT_VENDOR. */
 472     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
 473     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 474     ovs_be16 subtype;               /* NXAST_NOTE. */
 475     uint8_t note[6];                /* Start of user-defined data. */
 476     /* Possibly followed by additional user-defined data. */
 477 };
 478 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
 479
 480 /* Wildcard for tunnel ID. */
 481 #define NXFW_TUN_ID  (1 << 25)
 482
 483 #define NXFW_ALL NXFW_TUN_ID
 484 #define OVSFW_ALL (OFPFW_ALL | NXFW_ALL)
 485 \f
 486 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
 487  *
 488  * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches.  This
 489  * structure is fixed-length and hence difficult to extend.  This section
 490  * describes a more flexible, variable-length flow match, called "nx_match" for
 491  * short, that is also supported by Open vSwitch.  This section also defines a
 492  * replacement for each OpenFlow message that includes struct ofp_match.
 493  *
 494  *
 495  * Format
 496  * ======
 497  *
 498  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
 499  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
 500  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
 501  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
 502  * "body".
 503  *
 504  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
 505  *
 506  * |<-------------------- nxm_type ------------------>|
 507  * |                                                  |
 508  * |31                              16 15            9| 8 7                0
 509  * +----------------------------------+---------------+--+------------------+
 510  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
 511  * +----------------------------------+---------------+--+------------------+
 512  *
 513  * The most-significant 23 bits of the header are collectively "nxm_type".
 514  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
 515  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
 516  * designates a protocol header, such as the Ethernet type, but it can also
 517  * refer to packet metadata, such as the switch port on which a packet arrived.
 518  *
 519  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
 520  * of this bit is explained later.
 521  *
 522  * The least-significant 8 bits are "nxm_length", a positive integer.  The
 523  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
 524  * bytes.
 525  *
 526  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
 527  * constant.  It is included only to allow software to minimally parse
 528  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
 529  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
 530  *
 531  *
 532  * Semantics
 533  * =========
 534  *
 535  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
 536  *
 537  * An nxm_entry places a constraint on the packets matched by the nx_match:
 538  *
 539  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
 540  *     field, called "nxm_value".  The nx_match matches only packets in which
 541  *     the field equals nxm_value.
 542  *
 543  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
 544  *     field (nxm_value), followed by a bitmask of the same length as the
 545  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
 546  *     nx_match matches only packets for which bit J in the given field's value
 547  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
 548  *     corresponding bits in nxm_value and the field's value to be ignored.
 549  *     (The sense of the nxm_mask bits is the opposite of that used by the
 550  *     "wildcards" member of struct ofp_match.)
 551  *
 552  *     When nxm_hasmask is 1, nxm_length is always even.
 553  *
 554  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
 555  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
 556  *     nxm_hasmask.
 557  *
 558  * When there are multiple "nxm_entry"s, all of the constraints must be met.
 559  *
 560  *
 561  * Mask Restrictions
 562  * =================
 563  *
 564  * Masks may be restricted:
 565  *
 566  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
 567  *     must always be 0 when these fields are specified.  For example, the
 568  *     field that identifies the port on which a packet was received may not be
 569  *     masked.
 570  *
 571  *   - Some nxm_types that do support masked wildcards may only support certain
 572  *     nxm_mask patterns.  For example, fields that have IPv4 address values
 573  *     may be restricted to CIDR masks.
 574  *
 575  * These restrictions should be noted in specifications for individual fields.
 576  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
 577  * disallows, if the switch correctly implements support for that nxm_hasmask
 578  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
 579  * contains a nxm_hasmask or nxm_mask value that it does not support.
 580  *
 581  *
 582  * Prerequisite Restrictions
 583  * =========================
 584  *
 585  * The presence of an nxm_entry with a given nxm_type may be restricted based
 586  * on the presence of or values of other "nxm_entry"s.  For example:
 587  *
 588  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
 589  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
 590  *     and nxm_value=0x0800.  That is, matching on the IP source address is
 591  *     allowed only if the Ethernet type is explicitly set to IP.
 592  *
 593  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
 594  *     by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
 595  *     nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
 596  *     nxm_hasmask=0, nxm_value=6, in that order.  That is, matching on the TCP
 597  *     source port is allowed only if the Ethernet type is IP and the IP
 598  *     protocol is TCP.
 599  *
 600  * These restrictions should be noted in specifications for individual fields.
 601  * A switch may implement relaxed versions of these restrictions.  A switch
 602  * must reject an attempt to set up a flow that violates its restrictions.
 603  *
 604  *
 605  * Ordering Restrictions
 606  * =====================
 607  *
 608  * An nxm_entry that has prerequisite restrictions must appear after the
 609  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
 610  * nx_match is not otherwise constrained.
 611  *
 612  * Any given nxm_type may appear in an nx_match at most once.
 613  *
 614  *
 615  * nxm_entry Examples
 616  * ==================
 617  *
 618  * These examples show the format of a single nxm_entry with particular
 619  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
 620  * numbers and byte indexes.
 621  *
 622  *
 623  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
 624  *
 625  *  0          3  4   5
 626  * +------------+---+---+
 627  * |   header   | v | m |
 628  * +------------+---+---+
 629  *
 630  *
 631  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
 632  *
 633  *  0          3 4    5
 634  * +------------+------+
 635  * |   header   | value|
 636  * +------------+------+
 637  *
 638  *
 639  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
 640  *
 641  *  0          3 4           7
 642  * +------------+-------------+
 643  * |   header   |  nxm_value  |
 644  * +------------+-------------+
 645  *
 646  *
 647  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
 648  *
 649  *  0          3 4                9
 650  * +------------+------------------+
 651  * |   header   |     nxm_value    |
 652  * +------------+------------------+
 653  *
 654  *
 655  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
 656  *
 657  *  0          3 4                9 10              15
 658  * +------------+------------------+------------------+
 659  * |   header   |     nxm_value    |      nxm_mask    |
 660  * +------------+------------------+------------------+
 661  *
 662  *
 663  * Error Reporting
 664  * ===============
 665  *
 666  * A switch should report an error in an nx_match using error type
 667  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
 668  * should report a specific error code, if one is assigned for the particular
 669  * problem, but NXBRC_NXM_INVALID is also available to report a generic
 670  * nx_match error.
 671  */
 672
 673 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
 674     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
 675 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
 676     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
 677 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
 678     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
 679 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
 680 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
 681 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
 682 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
 683 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
 684
 685 #define NXM_MAKE_WILD_HEADER(HEADER) \
 686         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
 687
 688 /* ## ------------------------------- ## */
 689 /* ## OpenFlow 1.0-compatible fields. ## */
 690 /* ## ------------------------------- ## */
 691
 692 /* Physical or virtual port on which the packet was received.
 693  *
 694  * Prereqs: None.
 695  *
 696  * Format: 16-bit integer in network byte order.
 697  *
 698  * Masking: Not maskable. */
 699 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
 700
 701 /* Source or destination address in Ethernet header.
 702  *
 703  * Prereqs: None.
 704  *
 705  * Format: 48-bit Ethernet MAC address.
 706  *
 707  * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
 708  *   be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
 709  *   are all-0-bits or all-1-bits).  Support for other patterns and for masking
 710  *   of NXM_OF_ETH_SRC is optional. */
 711 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
 712 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
 713 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
 714
 715 /* Packet's Ethernet type.
 716  *
 717  * For an Ethernet II packet this is taken from the Ethernet header.  For an
 718  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
 719  * A packet that has neither format has value 0x05ff
 720  * (OFP_DL_TYPE_NOT_ETH_TYPE).
 721  *
 722  * For a packet with an 802.1Q header, this is the type of the encapsulated
 723  * frame.
 724  *
 725  * Prereqs: None.
 726  *
 727  * Format: 16-bit integer in network byte order.
 728  *
 729  * Masking: Not maskable. */
 730 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
 731
 732 /* 802.1Q TCI.
 733  *
 734  * For a packet with an 802.1Q header, this is the Tag Control Information
 735  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
 736  * header, this has value 0.
 737  *
 738  * Prereqs: None.
 739  *
 740  * Format: 16-bit integer in network byte order.
 741  *
 742  * Masking: Arbitrary masks.
 743  *
 744  * This field can be used in various ways:
 745  *
 746  *   - If it is not constrained at all, the nx_match matches packets without
 747  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
 748  *
 749  *   - Testing for an exact match with 0 matches only packets without an
 750  *     802.1Q header.
 751  *
 752  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
 753  *     that have an 802.1Q header with a specified VID and PCP.
 754  *
 755  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
 756  *     not make sense.  The switch may reject this combination.
 757  *
 758  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
 759  *     packets that have an 802.1Q header with that VID (and any PCP).
 760  *
 761  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
 762  *     packets that have an 802.1Q header with that PCP (and any VID).
 763  *
 764  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
 765  *     header or with an 802.1Q header with a VID of 0.
 766  *
 767  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
 768  *     header or with an 802.1Q header with a PCP of 0.
 769  *
 770  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
 771  *     header or with an 802.1Q header with both VID and PCP of 0.
 772  */
 773 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
 774 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
 775
 776 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
 777  *
 778  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
 779  *
 780  * Format: 8-bit integer with 2 least-significant bits forced to 0.
 781  *
 782  * Masking: Not maskable. */
 783 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
 784
 785 /* The "protocol" byte in the IP header.
 786  *
 787  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
 788  *
 789  * Format: 8-bit integer.
 790  *
 791  * Masking: Not maskable. */
 792 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
 793
 794 /* The source or destination address in the IP header.
 795  *
 796  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
 797  *
 798  * Format: 32-bit integer in network byte order.
 799  *
 800  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
 801  *   high-order bits set to 1 and the other 32-N bits set to 0. */
 802 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
 803 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
 804 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
 805 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
 806
 807 /* The source or destination port in the TCP header.
 808  *
 809  * Prereqs:
 810  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
 811  *   NXM_OF_IP_PROTO must match 6 exactly.
 812  *
 813  * Format: 16-bit integer in network byte order.
 814  *
 815  * Masking: Not maskable. */
 816 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
 817 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
 818
 819 /* The source or destination port in the UDP header.
 820  *
 821  * Prereqs:
 822  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
 823  *   NXM_OF_IP_PROTO must match 17 exactly.
 824  *
 825  * Format: 16-bit integer in network byte order.
 826  *
 827  * Masking: Not maskable. */
 828 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
 829 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
 830
 831 /* The type or code in the ICMP header.
 832  *
 833  * Prereqs:
 834  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
 835  *   NXM_OF_IP_PROTO must match 1 exactly.
 836  *
 837  * Format: 8-bit integer.
 838  *
 839  * Masking: Not maskable. */
 840 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
 841 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
 842
 843 /* ARP opcode.
 844  *
 845  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
 846  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
 847  * matching.
 848  *
 849  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
 850  *
 851  * Format: 16-bit integer in network byte order.
 852  *
 853  * Masking: Not maskable. */
 854 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
 855
 856 /* For an Ethernet+IP ARP packet, the source or target protocol address
 857  * in the ARP header.  Always 0 otherwise.
 858  *
 859  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
 860  *
 861  * Format: 32-bit integer in network byte order.
 862  *
 863  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
 864  *   high-order bits set to 1 and the other 32-N bits set to 0. */
 865 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
 866 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
 867 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
 868 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
 869
 870 /* ## ------------------------ ## */
 871 /* ## Nicira match extensions. ## */
 872 /* ## ------------------------ ## */
 873
 874 /* Metadata registers.
 875  *
 876  * Registers initially have value 0.  Actions allow register values to be
 877  * manipulated.
 878  *
 879  * Prereqs: None.
 880  *
 881  * Format: Array of 32-bit integer registers.  Space is reserved for up to
 882  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
 883  *
 884  * Masking: Arbitrary masks. */
 885 #define NXM_NX_MAX_REGS 16
 886 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
 887 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
 888 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
 889 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
 890 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
 891 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
 892 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
 893 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
 894 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
 895 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
 896 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
 897 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
 898 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
 899
 900 /* Tunnel ID.
 901  *
 902  * For a packet received via GRE tunnel including a (32-bit) key, the key is
 903  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
 904  * the value is 0.
 905  *
 906  * Prereqs: None.
 907  *
 908  * Format: 64-bit integer in network byte order.
 909  *
 910  * Masking: Arbitrary masks. */
 911 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
 912 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
 913
 914 /* ## --------------------- ## */
 915 /* ## Requests and replies. ## */
 916 /* ## --------------------- ## */
 917
 918 enum nx_flow_format {
 919     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
 920     NXFF_TUN_ID_FROM_COOKIE = 1, /* OpenFlow 1.0, plus obtain tunnel ID from
 921                                   * cookie. */
 922     NXFF_NXM = 2                 /* Nicira extended match. */
 923 };
 924
 925 /* NXT_SET_FLOW_FORMAT request. */
 926 struct nxt_set_flow_format {
 927     struct ofp_header header;
 928     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 929     ovs_be32 subtype;           /* NXT_SET_FLOW_FORMAT. */
 930     ovs_be32 format;            /* One of NXFF_*. */
 931 };
 932 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
 933
 934 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
 935 struct nx_flow_mod {
 936     struct nicira_header nxh;
 937     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
 938     ovs_be16 command;             /* One of OFPFC_*. */
 939     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
 940     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
 941     ovs_be16 priority;            /* Priority level of flow entry. */
 942     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
 943                                      Not meaningful for OFPFC_DELETE*. */
 944     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
 945                                      matching entries to include this as an
 946                                      output port.  A value of OFPP_NONE
 947                                      indicates no restriction. */
 948     ovs_be16 flags;               /* One of OFPFF_*. */
 949     ovs_be16 match_len;           /* Size of nx_match. */
 950     uint8_t pad[6];               /* Align to 64-bits. */
 951     /* Followed by:
 952      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
 953      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
 954      *     all-zero bytes, then
 955      *   - Actions to fill out the remainder of the message length (always a
 956      *     multiple of 8).
 957      */
 958 };
 959 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
 960
 961 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
 962 struct nx_flow_removed {
 963     struct nicira_header nxh;
 964     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
 965     ovs_be16 priority;        /* Priority level of flow entry. */
 966     uint8_t reason;           /* One of OFPRR_*. */
 967     uint8_t pad[1];           /* Align to 32-bits. */
 968     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
 969     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
 970                                  duration_sec. */
 971     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
 972     ovs_be16 match_len;       /* Size of nx_match. */
 973     ovs_be64 packet_count;
 974     ovs_be64 byte_count;
 975     /* Followed by:
 976      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
 977      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
 978      *     all-zero bytes. */
 979 };
 980 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
 981
 982 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
 983  * request). */
 984 struct nx_flow_stats_request {
 985     struct nicira_stats_msg nsm;
 986     ovs_be16 out_port;        /* Require matching entries to include this
 987                                  as an output port.  A value of OFPP_NONE
 988                                  indicates no restriction. */
 989     ovs_be16 match_len;       /* Length of nx_match. */
 990     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 991                                  or 0xff for all tables. */
 992     uint8_t pad[3];           /* Align to 64 bits. */
 993     /* Followed by:
 994      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
 995      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
 996      *     all-zero bytes, which must also exactly fill out the length of the
 997      *     message.
 998      */
 999 };
1000 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1001
1002 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1003  * OFPST_FLOW reply). */
1004 struct nx_flow_stats {
1005     ovs_be16 length;          /* Length of this entry. */
1006     uint8_t table_id;         /* ID of table flow came from. */
1007     uint8_t pad;
1008     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1009     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1010                                  beyond duration_sec. */
1011     ovs_be16 priority;        /* Priority of the entry. Only meaningful
1012                                  when this is not an exact-match entry. */
1013     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1014     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1015     ovs_be16 match_len;       /* Length of nx_match. */
1016     uint8_t pad2[4];          /* Align to 64 bits. */
1017     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1018     ovs_be64 packet_count;    /* Number of packets in flow. */
1019     ovs_be64 byte_count;      /* Number of bytes in flow. */
1020     /* Followed by:
1021      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1022      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1023      *     all-zero bytes, then
1024      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1025      *     of 8).
1026      */
1027 };
1028 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1029
1030 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1031  * OFPST_AGGREGATE request). */
1032 struct nx_aggregate_stats_request {
1033     struct nicira_stats_msg nsm;
1034     ovs_be16 out_port;        /* Require matching entries to include this
1035                                  as an output port.  A value of OFPP_NONE
1036                                  indicates no restriction. */
1037     ovs_be16 match_len;       /* Length of nx_match. */
1038     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1039                                  or 0xff for all tables. */
1040     uint8_t pad[3];           /* Align to 64 bits. */
1041     /* Followed by:
1042      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1043      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1044      *     all-zero bytes, which must also exactly fill out the length of the
1045      *     message.
1046      */
1047 };
1048 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1049
1050 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1051  * OFPST_AGGREGATE reply).
1052  *
1053  * ofp_aggregate_stats_reply does not contain an ofp_match structure, so we
1054  * reuse it entirely.  (It would be very odd to use OFPST_AGGREGATE to reply to
1055  * an NXST_AGGREGATE request, so we don't do that.) */
1056 struct nx_aggregate_stats_reply {
1057     struct nicira_stats_msg nsm;
1058     struct ofp_aggregate_stats_reply asr;
1059 };
1060 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1061
1062 #endif /* openflow/nicira-ext.h */