include/openflow/nicira-ext.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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_ERROR 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 /* Nicira vendor requests and replies. */
  71
  72 /* Header for Nicira vendor requests and replies. */
  73 struct nicira_header {
  74     struct ofp_header header;
  75     ovs_be32 vendor;            /* NX_VENDOR_ID. */
  76     ovs_be32 subtype;           /* One of NXT_* below. */
  77 };
  78 OFP_ASSERT(sizeof(struct nicira_header) == 16);
  79
  80 /* Values for the 'subtype' member of struct nicira_header. */
  81 enum nicira_type {
  82     /* No longer used. */
  83     NXT_STATUS_REQUEST__OBSOLETE = 0,
  84     NXT_STATUS_REPLY__OBSOLETE = 1,
  85     NXT_ACT_SET_CONFIG__OBSOLETE = 2,
  86     NXT_ACT_GET_CONFIG__OBSOLETE = 3,
  87     NXT_COMMAND_REQUEST__OBSOLETE = 4,
  88     NXT_COMMAND_REPLY__OBSOLETE = 5,
  89     NXT_FLOW_END_CONFIG__OBSOLETE = 6,
  90     NXT_FLOW_END__OBSOLETE = 7,
  91     NXT_MGMT__OBSOLETE = 8,
  92     NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
  93
  94     /* Controller role support.  The request body is struct nx_role_request.
  95      * The reply echos the request. */
  96     NXT_ROLE_REQUEST = 10,
  97     NXT_ROLE_REPLY = 11,
  98
  99     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 100     NXT_SET_FLOW_FORMAT = 12,   /* Set flow format. */
 101     NXT_FLOW_MOD = 13,          /* Analogous to OFPT_FLOW_MOD. */
 102     NXT_FLOW_REMOVED = 14,      /* Analogous to OFPT_FLOW_REMOVED. */
 103
 104     /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
 105      * designate the table to which a flow is to be added?  See the big comment
 106      * on struct nx_flow_mod_table_id for more information. */
 107     NXT_FLOW_MOD_TABLE_ID = 15,
 108
 109     /* Alternative PACKET_IN message formats. */
 110     NXT_SET_PACKET_IN_FORMAT = 16, /* Set Packet In format. */
 111     NXT_PACKET_IN = 17,            /* Nicira Packet In. */
 112
 113     /* Are the idle_age and hard_age members in struct nx_flow_stats supported?
 114      * If so, the switch does not reply to this message (which consists only of
 115      * a "struct nicira_header").  If not, the switch sends an error reply. */
 116     NXT_FLOW_AGE = 18,
 117
 118     NXT_SET_ASYNC_CONFIG = 19,  /* struct nx_async_config. */
 119     NXT_SET_CONTROLLER_ID = 20, /* struct nx_controller_id. */
 120 };
 121
 122 /* Header for Nicira vendor stats request and reply messages. */
 123 struct nicira_stats_msg {
 124     struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
 125     ovs_be32 subtype;           /* One of NXST_* below. */
 126     uint8_t pad[4];             /* Align to 64-bits. */
 127 };
 128 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
 129
 130 /* Values for the 'subtype' member of struct nicira_stats_msg. */
 131 enum nicira_stats_type {
 132     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 133     NXST_FLOW,                  /* Analogous to OFPST_FLOW. */
 134     NXST_AGGREGATE              /* Analogous to OFPST_AGGREGATE. */
 135 };
 136
 137 /* Fields to use when hashing flows. */
 138 enum nx_hash_fields {
 139     /* Ethernet source address (NXM_OF_ETH_SRC) only. */
 140     NX_HASH_FIELDS_ETH_SRC,
 141
 142     /* L2 through L4, symmetric across src/dst.  Specifically, each of the
 143      * following fields, if present, is hashed (slashes separate symmetric
 144      * pairs):
 145      *
 146      *  - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
 147      *  - NXM_OF_ETH_TYPE
 148      *  - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
 149      *  - NXM_OF_IP_PROTO
 150      *  - NXM_OF_IP_SRC / NXM_OF_IP_DST
 151      *  - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
 152      */
 153     NX_HASH_FIELDS_SYMMETRIC_L4
 154 };
 155
 156 /* This command enables or disables an Open vSwitch extension that allows a
 157  * controller to specify the OpenFlow table to which a flow should be added,
 158  * instead of having the switch decide which table is most appropriate as
 159  * required by OpenFlow 1.0.  By default, the extension is disabled.
 160  *
 161  * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
 162  * 16-bit 'command' member as two separate fields.  The upper 8 bits are used
 163  * as the table ID, the lower 8 bits specify the command as usual.  A table ID
 164  * of 0xff is treated like a wildcarded table ID.
 165  *
 166  * The specific treatment of the table ID depends on the type of flow mod:
 167  *
 168  *    - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
 169  *      table.  If an identical flow already exists in that table only, then it
 170  *      is replaced.  If the flow cannot be placed in the specified table,
 171  *      either because the table is full or because the table cannot support
 172  *      flows of the given type, the switch replies with an
 173  *      OFPFMFC_ALL_TABLES_FULL error.  (A controller can distinguish these
 174  *      cases by comparing the current and maximum number of entries reported
 175  *      in ofp_table_stats.)
 176  *
 177  *      If the table ID is wildcarded, the switch picks an appropriate table
 178  *      itself.  If an identical flow already exist in the selected flow table,
 179  *      then it is replaced.  The choice of table might depend on the flows
 180  *      that are already in the switch; for example, if one table fills up then
 181  *      the switch might fall back to another one.
 182  *
 183  *    - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
 184  *      within that table are matched and modified or deleted.  If the table ID
 185  *      is wildcarded, flows within any table may be matched and modified or
 186  *      deleted.
 187  *
 188  *    - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
 189  *      only a flow within that table may be matched and modified or deleted.
 190  *      If the table ID is wildcarded and exactly one flow within any table
 191  *      matches, then it is modified or deleted; if flows in more than one
 192  *      table match, then none is modified or deleted.
 193  */
 194 struct nx_flow_mod_table_id {
 195     struct ofp_header header;
 196     uint32_t vendor;            /* NX_VENDOR_ID. */
 197     uint32_t subtype;           /* NXT_FLOW_MOD_TABLE_ID. */
 198     uint8_t set;                /* Nonzero to enable, zero to disable. */
 199     uint8_t pad[7];
 200 };
 201 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 24);
 202
 203 enum nx_packet_in_format {
 204     NXPIF_OPENFLOW10 = 0,       /* Standard OpenFlow 1.0 compatible. */
 205     NXPIF_NXM = 1               /* Nicira Extended. */
 206 };
 207
 208 /* NXT_SET_PACKET_IN_FORMAT request. */
 209 struct nx_set_packet_in_format {
 210     struct nicira_header nxh;
 211     ovs_be32 format;            /* One of NXPIF_*. */
 212 };
 213 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 20);
 214
 215 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
 216  *
 217  * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN
 218  * with some minor tweaks.  Most notably NXT_PACKET_IN includes the cookie of
 219  * the rule which triggered the NXT_PACKET_IN message, and the match fields are
 220  * in NXM format.
 221  *
 222  * The match fields in the NXT_PACKET_IN are intended to contain flow
 223  * processing metadata collected at the time the NXT_PACKET_IN message was
 224  * triggered.  It is minimally required to contain the NXM_OF_IN_PORT of the
 225  * packet, but may include other NXM headers such as flow registers.  The match
 226  * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc).
 227  * However, this information can typically be found in the packet directly, so
 228  * it may be redundant.
 229  *
 230  * Whereas in most cases a controller can expect to only get back NXM fields
 231  * that it set up itself (e.g. flow dumps will ordinarily report only NXM
 232  * fields from flows that the controller added), NXT_PACKET_IN messages might
 233  * contain fields that the controller does not understand, because the switch
 234  * might support fields (new registers, new protocols, etc.) that the
 235  * controller does not.  The controller must prepared to tolerate these.
 236  *
 237  * The 'cookie' and 'table_id' fields have no meaning when 'reason' is
 238  * OFPR_NO_MATCH.  In this case they should be set to 0. */
 239 struct nx_packet_in {
 240     struct nicira_header nxh;
 241     ovs_be32 buffer_id;       /* ID assigned by datapath. */
 242     ovs_be16 total_len;       /* Full length of frame. */
 243     uint8_t reason;           /* Reason packet is sent (one of OFPR_*). */
 244     uint8_t table_id;         /* ID of the table that was looked up. */
 245     ovs_be64 cookie;          /* Cookie of the rule that was looked up. */
 246     ovs_be16 match_len;       /* Size of nx_match. */
 247     uint8_t pad[6];           /* Align to 64-bits. */
 248     /* Followed by:
 249      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
 250      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
 251      *     all-zero bytes, then
 252      *   - Exactly 2 all-zero padding bytes, then
 253      *   - An Ethernet frame whose length is inferred from nxh.header.length.
 254      *
 255      * The padding bytes preceding the Ethernet frame ensure that the IP
 256      * header (if any) following the Ethernet header is 32-bit aligned. */
 257
 258     /* uint8_t nxm_fields[...]; */ /* Match. */
 259     /* uint8_t pad[2]; */          /* Align to 64 bit + 16 bit. */
 260     /* uint8_t data[0]; */         /* Ethernet frame. */
 261 };
 262 OFP_ASSERT(sizeof(struct nx_packet_in) == 40);
 263
 264 /* Configures the "role" of the sending controller.  The default role is:
 265  *
 266  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
 267  *      OpenFlow features.
 268  *
 269  * The other possible roles are a related pair:
 270  *
 271  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
 272  *      be at most one Master controller at a time: when a controller
 273  *      configures itself as Master, any existing Master is demoted to the
 274  *      Slave role.
 275  *
 276  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
 277  *      OpenFlow features.  In particular attempts to modify the flow table
 278  *      will be rejected with an OFPBRC_EPERM error.
 279  *
 280  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
 281  *      messages, but they do receive OFPT_PORT_STATUS messages.
 282  */
 283 struct nx_role_request {
 284     struct nicira_header nxh;
 285     ovs_be32 role;              /* One of NX_ROLE_*. */
 286 };
 287 OFP_ASSERT(sizeof(struct nx_role_request) == 20);
 288
 289 enum nx_role {
 290     NX_ROLE_OTHER,              /* Default role, full access. */
 291     NX_ROLE_MASTER,             /* Full access, at most one. */
 292     NX_ROLE_SLAVE               /* Read-only access. */
 293 };
 294
 295 /* NXT_SET_ASYNC_CONFIG.
 296  *
 297  * Sent by a controller, this message configures the asynchronous messages that
 298  * the controller wants to receive.  Element 0 in each array specifies messages
 299  * of interest when the controller has an "other" or "master" role; element 1,
 300  * when the controller has a "slave" role.
 301  *
 302  * Each array element is a bitmask in which a 0-bit disables receiving a
 303  * particular message and a 1-bit enables receiving it.  Each bit controls the
 304  * message whose 'reason' corresponds to the bit index.  For example, the bit
 305  * with value 1<<2 == 4 in port_status_mask[1] determines whether the
 306  * controller will receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY
 307  * (value 2) when the controller has a "slave" role.
 308  */
 309 struct nx_async_config {
 310     struct nicira_header nxh;
 311     ovs_be32 packet_in_mask[2];    /* Bitmasks of OFPR_* values. */
 312     ovs_be32 port_status_mask[2];  /* Bitmasks of OFPRR_* values. */
 313     ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */
 314 };
 315 OFP_ASSERT(sizeof(struct nx_async_config) == 40);
 316 \f
 317 /* Nicira vendor flow actions. */
 318
 319 enum nx_action_subtype {
 320     NXAST_SNAT__OBSOLETE,       /* No longer used. */
 321     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
 322     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
 323     NXAST_DROP_SPOOFED_ARP__OBSOLETE,
 324     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
 325     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
 326     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
 327     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
 328     NXAST_NOTE,                 /* struct nx_action_note */
 329     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
 330     NXAST_MULTIPATH,            /* struct nx_action_multipath */
 331     NXAST_AUTOPATH,             /* struct nx_action_autopath */
 332     NXAST_BUNDLE,               /* struct nx_action_bundle */
 333     NXAST_BUNDLE_LOAD,          /* struct nx_action_bundle */
 334     NXAST_RESUBMIT_TABLE,       /* struct nx_action_resubmit */
 335     NXAST_OUTPUT_REG,           /* struct nx_action_output_reg */
 336     NXAST_LEARN,                /* struct nx_action_learn */
 337     NXAST_EXIT,                 /* struct nx_action_header */
 338     NXAST_DEC_TTL,              /* struct nx_action_header */
 339     NXAST_FIN_TIMEOUT,          /* struct nx_action_fin_timeout */
 340     NXAST_CONTROLLER,           /* struct nx_action_controller */
 341 };
 342
 343 /* Header for Nicira-defined actions. */
 344 struct nx_action_header {
 345     ovs_be16 type;                  /* OFPAT_VENDOR. */
 346     ovs_be16 len;                   /* Length is 16. */
 347     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 348     ovs_be16 subtype;               /* NXAST_*. */
 349     uint8_t pad[6];
 350 };
 351 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
 352
 353 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
 354  *
 355  * These actions search one of the switch's flow tables:
 356  *
 357  *    - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
 358  *      it specifies the table to search.
 359  *
 360  *    - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
 361  *      NXAST_RESUBMIT regardless of 'table'), it searches the current flow
 362  *      table, that is, the OpenFlow flow table that contains the flow from
 363  *      which this action was obtained.  If this action did not come from a
 364  *      flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
 365  *      is the current table.
 366  *
 367  * The flow table lookup uses a flow that may be slightly modified from the
 368  * original lookup:
 369  *
 370  *    - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
 371  *      is used as the flow's in_port.
 372  *
 373  *    - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
 374  *      then its value is used as the flow's in_port.  Otherwise, the original
 375  *      in_port is used.
 376  *
 377  *    - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
 378  *      resubmit action, then the flow is updated with the new values.
 379  *
 380  * Following the lookup, the original in_port is restored.
 381  *
 382  * If the modified flow matched in the flow table, then the corresponding
 383  * actions are executed.  Afterward, actions following the resubmit in the
 384  * original set of actions, if any, are executed; any changes made to the
 385  * packet (e.g. changes to VLAN) by secondary actions persist when those
 386  * actions are executed, although the original in_port is restored.
 387  *
 388  * Resubmit actions may be used any number of times within a set of actions.
 389  *
 390  * Resubmit actions may nest to an implementation-defined depth.  Beyond this
 391  * implementation-defined depth, further resubmit actions are simply ignored.
 392  *
 393  * NXAST_RESUBMIT ignores 'table' and 'pad'.  NXAST_RESUBMIT_TABLE requires
 394  * 'pad' to be all-bits-zero.
 395  *
 396  * Open vSwitch 1.0.1 and earlier did not support recursion.  Open vSwitch
 397  * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
 398  */
 399 struct nx_action_resubmit {
 400     ovs_be16 type;                  /* OFPAT_VENDOR. */
 401     ovs_be16 len;                   /* Length is 16. */
 402     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 403     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
 404     ovs_be16 in_port;               /* New in_port for checking flow table. */
 405     uint8_t table;                  /* NXAST_RESUBMIT_TABLE: table to use. */
 406     uint8_t pad[3];
 407 };
 408 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
 409
 410 /* Action structure for NXAST_SET_TUNNEL.
 411  *
 412  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
 413  * bits of the tunnel ID are set to 0. */
 414 struct nx_action_set_tunnel {
 415     ovs_be16 type;                  /* OFPAT_VENDOR. */
 416     ovs_be16 len;                   /* Length is 16. */
 417     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 418     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
 419     uint8_t pad[2];
 420     ovs_be32 tun_id;                /* Tunnel ID. */
 421 };
 422 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
 423
 424 /* Action structure for NXAST_SET_TUNNEL64.
 425  *
 426  * Sets the encapsulating tunnel ID to a 64-bit value. */
 427 struct nx_action_set_tunnel64 {
 428     ovs_be16 type;                  /* OFPAT_VENDOR. */
 429     ovs_be16 len;                   /* Length is 16. */
 430     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 431     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
 432     uint8_t pad[6];
 433     ovs_be64 tun_id;                /* Tunnel ID. */
 434 };
 435 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
 436
 437 /* Action structure for NXAST_SET_QUEUE.
 438  *
 439  * Set the queue that should be used when packets are output.  This is similar
 440  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
 441  * an argument.  This allows the queue to be defined before the port is
 442  * known. */
 443 struct nx_action_set_queue {
 444     ovs_be16 type;                  /* OFPAT_VENDOR. */
 445     ovs_be16 len;                   /* Length is 16. */
 446     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 447     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
 448     uint8_t pad[2];
 449     ovs_be32 queue_id;              /* Where to enqueue packets. */
 450 };
 451 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
 452
 453 /* Action structure for NXAST_POP_QUEUE.
 454  *
 455  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
 456  * were used.  Only the original queue can be restored this way; no stack is
 457  * maintained. */
 458 struct nx_action_pop_queue {
 459     ovs_be16 type;                  /* OFPAT_VENDOR. */
 460     ovs_be16 len;                   /* Length is 16. */
 461     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 462     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
 463     uint8_t pad[6];
 464 };
 465 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
 466
 467 /* Action structure for NXAST_REG_MOVE.
 468  *
 469  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
 470  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
 471  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
 472  * the next most significant bit, and so on.
 473  *
 474  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
 475  * sense to use nxm_hasmask=1 because the action does not do any kind of
 476  * matching; it uses the actual value of a field.)
 477  *
 478  * The following nxm_header values are potentially acceptable as 'src':
 479  *
 480  *   - NXM_OF_IN_PORT
 481  *   - NXM_OF_ETH_DST
 482  *   - NXM_OF_ETH_SRC
 483  *   - NXM_OF_ETH_TYPE
 484  *   - NXM_OF_VLAN_TCI
 485  *   - NXM_OF_IP_TOS
 486  *   - NXM_OF_IP_PROTO
 487  *   - NXM_OF_IP_SRC
 488  *   - NXM_OF_IP_DST
 489  *   - NXM_OF_TCP_SRC
 490  *   - NXM_OF_TCP_DST
 491  *   - NXM_OF_UDP_SRC
 492  *   - NXM_OF_UDP_DST
 493  *   - NXM_OF_ICMP_TYPE
 494  *   - NXM_OF_ICMP_CODE
 495  *   - NXM_OF_ARP_OP
 496  *   - NXM_OF_ARP_SPA
 497  *   - NXM_OF_ARP_TPA
 498  *   - NXM_NX_TUN_ID
 499  *   - NXM_NX_ARP_SHA
 500  *   - NXM_NX_ARP_THA
 501  *   - NXM_NX_ICMPV6_TYPE
 502  *   - NXM_NX_ICMPV6_CODE
 503  *   - NXM_NX_ND_SLL
 504  *   - NXM_NX_ND_TLL
 505  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 506  *
 507  * The following nxm_header values are potentially acceptable as 'dst':
 508  *
 509  *   - NXM_OF_ETH_DST
 510  *   - NXM_OF_ETH_SRC
 511  *   - NXM_OF_IP_TOS
 512  *   - NXM_OF_IP_SRC
 513  *   - NXM_OF_IP_DST
 514  *   - NXM_OF_TCP_SRC
 515  *   - NXM_OF_TCP_DST
 516  *   - NXM_OF_UDP_SRC
 517  *   - NXM_OF_UDP_DST
 518  *     Modifying any of the above fields changes the corresponding packet
 519  *     header.
 520  *
 521  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 522  *
 523  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
 524  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
 525  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
 526  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
 527  *     to the field's new value (with the CFI bit masked out).
 528  *
 529  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
 530  *     packet's next tunnel encapsulation.
 531  *
 532  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
 533  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
 534  * used only if the flow's nx_match includes an nxm_entry that specifies
 535  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
 536  *
 537  * The switch will reject actions for which src_ofs+n_bits is greater than the
 538  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
 539  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 540  */
 541 struct nx_action_reg_move {
 542     ovs_be16 type;                  /* OFPAT_VENDOR. */
 543     ovs_be16 len;                   /* Length is 16. */
 544     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 545     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
 546     ovs_be16 n_bits;                /* Number of bits. */
 547     ovs_be16 src_ofs;               /* Starting bit offset in source. */
 548     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
 549     ovs_be32 src;                   /* Source register. */
 550     ovs_be32 dst;                   /* Destination register. */
 551 };
 552 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
 553
 554 /* Action structure for NXAST_REG_LOAD.
 555  *
 556  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
 557  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
 558  * starts at 0 for the least-significant bit, 1 for the next most significant
 559  * bit, and so on.
 560  *
 561  * 'dst' is an nxm_header with nxm_hasmask=0.  See the documentation for
 562  * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
 563  * loading them.
 564  *
 565  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
 566  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
 567  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
 568  * also stored as one less than its true value:
 569  *
 570  *  15                           6 5                0
 571  * +------------------------------+------------------+
 572  * |              ofs             |    n_bits - 1    |
 573  * +------------------------------+------------------+
 574  *
 575  * The switch will reject actions for which ofs+n_bits is greater than the
 576  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
 577  * greater are set to 1, with error type OFPET_BAD_ACTION, code
 578  * OFPBAC_BAD_ARGUMENT.
 579  */
 580 struct nx_action_reg_load {
 581     ovs_be16 type;                  /* OFPAT_VENDOR. */
 582     ovs_be16 len;                   /* Length is 16. */
 583     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 584     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
 585     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
 586     ovs_be32 dst;                   /* Destination register. */
 587     ovs_be64 value;                 /* Immediate value. */
 588 };
 589 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
 590
 591 /* Action structure for NXAST_NOTE.
 592  *
 593  * This action has no effect.  It is variable length.  The switch does not
 594  * attempt to interpret the user-defined 'note' data in any way.  A controller
 595  * can use this action to attach arbitrary metadata to a flow.
 596  *
 597  * This action might go away in the future.
 598  */
 599 struct nx_action_note {
 600     ovs_be16 type;                  /* OFPAT_VENDOR. */
 601     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
 602     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 603     ovs_be16 subtype;               /* NXAST_NOTE. */
 604     uint8_t note[6];                /* Start of user-defined data. */
 605     /* Possibly followed by additional user-defined data. */
 606 };
 607 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
 608
 609 /* Action structure for NXAST_MULTIPATH.
 610  *
 611  * This action performs the following steps in sequence:
 612  *
 613  *    1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
 614  *       Refer to the definition of "enum nx_mp_fields" for details.
 615  *
 616  *       The 'basis' value is used as a universal hash parameter, that is,
 617  *       different values of 'basis' yield different hash functions.  The
 618  *       particular universal hash function used is implementation-defined.
 619  *
 620  *       The hashed fields' values are drawn from the current state of the
 621  *       flow, including all modifications that have been made by actions up to
 622  *       this point.
 623  *
 624  *    2. Applies the multipath link choice algorithm specified by 'algorithm',
 625  *       one of NX_MP_ALG_*.  Refer to the definition of "enum nx_mp_algorithm"
 626  *       for details.
 627  *
 628  *       The output of the algorithm is 'link', an unsigned integer less than
 629  *       or equal to 'max_link'.
 630  *
 631  *       Some algorithms use 'arg' as an additional argument.
 632  *
 633  *    3. Stores 'link' in dst[ofs:ofs+n_bits].  The format and semantics of
 634  *       'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
 635  *       action.
 636  *
 637  * The switch will reject actions that have an unknown 'fields', or an unknown
 638  * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
 639  * in which 'max_link' is greater than or equal to 2**n_bits, with error type
 640  * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 641  */
 642 struct nx_action_multipath {
 643     ovs_be16 type;              /* OFPAT_VENDOR. */
 644     ovs_be16 len;               /* Length is 32. */
 645     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 646     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
 647
 648     /* What fields to hash and how. */
 649     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
 650     ovs_be16 basis;             /* Universal hash parameter. */
 651     ovs_be16 pad0;
 652
 653     /* Multipath link choice algorithm to apply to hash value. */
 654     ovs_be16 algorithm;         /* One of NX_MP_ALG_*. */
 655     ovs_be16 max_link;          /* Number of output links, minus 1. */
 656     ovs_be32 arg;               /* Algorithm-specific argument. */
 657     ovs_be16 pad1;
 658
 659     /* Where to store the result. */
 660     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
 661     ovs_be32 dst;               /* Destination. */
 662 };
 663 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
 664
 665 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
 666  *
 667  * In the descriptions below, 'n_links' is max_link + 1. */
 668 enum nx_mp_algorithm {
 669     /* link = hash(flow) % n_links.
 670      *
 671      * Redistributes all traffic when n_links changes.  O(1) performance.  See
 672      * RFC 2992.
 673      *
 674      * Use UINT16_MAX for max_link to get a raw hash value. */
 675     NX_MP_ALG_MODULO_N,
 676
 677     /* link = hash(flow) / (MAX_HASH / n_links).
 678      *
 679      * Redistributes between one-quarter and one-half of traffic when n_links
 680      * changes.  O(1) performance.  See RFC 2992.
 681      */
 682     NX_MP_ALG_HASH_THRESHOLD,
 683
 684     /* for i in [0,n_links):
 685      *   weights[i] = hash(flow, i)
 686      * link = { i such that weights[i] >= weights[j] for all j != i }
 687      *
 688      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
 689      * performance.  If n_links is greater than a threshold (currently 64, but
 690      * subject to change), Open vSwitch will substitute another algorithm
 691      * automatically.  See RFC 2992. */
 692     NX_MP_ALG_HRW,              /* Highest Random Weight. */
 693
 694     /* i = 0
 695      * repeat:
 696      *     i = i + 1
 697      *     link = hash(flow, i) % arg
 698      * while link > max_link
 699      *
 700      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
 701      * performance when arg/max_link is bounded by a constant.
 702      *
 703      * Redistributes all traffic when arg changes.
 704      *
 705      * arg must be greater than max_link and for best performance should be no
 706      * more than approximately max_link * 2.  If arg is outside the acceptable
 707      * range, Open vSwitch will automatically substitute the least power of 2
 708      * greater than max_link.
 709      *
 710      * This algorithm is specific to Open vSwitch.
 711      */
 712     NX_MP_ALG_ITER_HASH         /* Iterative Hash. */
 713 };
 714 \f
 715 /* Action structure for NXAST_LEARN.
 716  *
 717  * This action adds or modifies a flow in an OpenFlow table, similar to
 718  * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'.  The new flow has the
 719  * specified idle timeout, hard timeout, priority, cookie, and flags.  The new
 720  * flow's match criteria and actions are built by applying each of the series
 721  * of flow_mod_spec elements included as part of the action.
 722  *
 723  * A flow_mod_spec starts with a 16-bit header.  A header that is all-bits-0 is
 724  * a no-op used for padding the action as a whole to a multiple of 8 bytes in
 725  * length.  Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
 726  * bits from a source to a destination.  In this case, the header contains
 727  * multiple fields:
 728  *
 729  *  15  14  13 12  11 10                              0
 730  * +------+---+------+---------------------------------+
 731  * |   0  |src|  dst |             n_bits              |
 732  * +------+---+------+---------------------------------+
 733  *
 734  * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'.  The
 735  * following table summarizes the meaning of each possible combination.
 736  * Details follow the table:
 737  *
 738  *   src dst  meaning
 739  *   --- ---  ----------------------------------------------------------
 740  *    0   0   Add match criteria based on value in a field.
 741  *    1   0   Add match criteria based on an immediate value.
 742  *    0   1   Add NXAST_REG_LOAD action to copy field into a different field.
 743  *    1   1   Add NXAST_REG_LOAD action to load immediate value into a field.
 744  *    0   2   Add OFPAT_OUTPUT action to output to port from specified field.
 745  *   All other combinations are undefined and not allowed.
 746  *
 747  * The flow_mod_spec header is followed by a source specification and a
 748  * destination specification.  The format and meaning of the source
 749  * specification depends on 'src':
 750  *
 751  *   - If 'src' is 0, the source bits are taken from a field in the flow to
 752  *     which this action is attached.  (This should be a wildcarded field.  If
 753  *     its value is fully specified then the source bits being copied have
 754  *     constant values.)
 755  *
 756  *     The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
 757  *     'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
 758  *     offset within that field.  The source bits are field[ofs:ofs+n_bits-1].
 759  *     'field' and 'ofs' are subject to the same restrictions as the source
 760  *     field in NXAST_REG_MOVE.
 761  *
 762  *   - If 'src' is 1, the source bits are a constant value.  The source
 763  *     specification is (n_bits+15)/16*2 bytes long.  Taking those bytes as a
 764  *     number in network order, the source bits are the 'n_bits'
 765  *     least-significant bits.  The switch will report an error if other bits
 766  *     in the constant are nonzero.
 767  *
 768  * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
 769  * ovs_be32 'field' and an ovs_be16 'ofs'.  'field' is an nxm_header with
 770  * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field.  The
 771  * meaning of the flow_mod_spec depends on 'dst':
 772  *
 773  *   - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
 774  *     flow.  The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
 775  *     packet equal the source bits.  'field' may be any nxm_header with
 776  *     nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
 777  *
 778  *     Order is significant.  Earlier flow_mod_specs must satisfy any
 779  *     prerequisites for matching fields specified later, by copying constant
 780  *     values into prerequisite fields.
 781  *
 782  *     The switch will reject flow_mod_specs that do not satisfy NXM masking
 783  *     restrictions.
 784  *
 785  *   - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
 786  *     the new flow.  The new flow copies the source bits into
 787  *     field[ofs:ofs+n_bits-1].  Actions are executed in the same order as the
 788  *     flow_mod_specs.
 789  *
 790  * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
 791  * empty.  It has the following meaning:
 792  *
 793  *   - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
 794  *     The new flow outputs to the OpenFlow port specified by the source field.
 795  *     Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
 796  *     OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported.  Other special ports
 797  *     may not be used.
 798  *
 799  * Resource Management
 800  * -------------------
 801  *
 802  * A switch has a finite amount of flow table space available for learning.
 803  * When this space is exhausted, no new learning table entries will be learned
 804  * until some existing flow table entries expire.  The controller should be
 805  * prepared to handle this by flooding (which can be implemented as a
 806  * low-priority flow).
 807  *
 808  * If a learned flow matches a single TCP stream with a relatively long
 809  * timeout, one may make the best of resource constraints by setting
 810  * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
 811  * both, to shorter timeouts.  When either of these is specified as a nonzero
 812  * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
 813  * the learned flow.
 814  *
 815  * Examples
 816  * --------
 817  *
 818  * The following examples give a prose description of the flow_mod_specs along
 819  * with informal notation for how those would be represented and a hex dump of
 820  * the bytes that would be required.
 821  *
 822  * These examples could work with various nx_action_learn parameters.  Typical
 823  * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
 824  * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
 825  *
 826  * 1. Learn input port based on the source MAC, with lookup into
 827  *    NXM_NX_REG1[16:31] by resubmit to in_port=99:
 828  *
 829  *    Match on in_port=99:
 830  *       ovs_be16(src=1, dst=0, n_bits=16),               20 10
 831  *       ovs_be16(99),                                    00 63
 832  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
 833  *
 834  *    Match Ethernet destination on Ethernet source from packet:
 835  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
 836  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
 837  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
 838  *
 839  *    Set NXM_NX_REG1[16:31] to the packet's input port:
 840  *       ovs_be16(src=0, dst=1, n_bits=16),               08 10
 841  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
 842  *       ovs_be32(NXM_NX_REG1), ovs_be16(16)              00 01 02 04 00 10
 843  *
 844  *    Given a packet that arrived on port A with Ethernet source address B,
 845  *    this would set up the flow "in_port=99, dl_dst=B,
 846  *    actions=load:A->NXM_NX_REG1[16..31]".
 847  *
 848  *    In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
 849  *    NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
 850  *    load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
 851  *
 852  * 2. Output to input port based on the source MAC and VLAN VID, with lookup
 853  *    into NXM_NX_REG1[16:31]:
 854  *
 855  *    Match on same VLAN ID as packet:
 856  *       ovs_be16(src=0, dst=0, n_bits=12),               00 0c
 857  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
 858  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
 859  *
 860  *    Match Ethernet destination on Ethernet source from packet:
 861  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
 862  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
 863  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
 864  *
 865  *    Output to the packet's input port:
 866  *       ovs_be16(src=0, dst=2, n_bits=16),               10 10
 867  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
 868  *
 869  *    Given a packet that arrived on port A with Ethernet source address B in
 870  *    VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
 871  *    actions=output:A".
 872  *
 873  *    In syntax accepted by ovs-ofctl, this action is:
 874  *    learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
 875  *    output:NXM_OF_IN_PORT[])
 876  *
 877  * 3. Here's a recipe for a very simple-minded MAC learning switch.  It uses a
 878  *    10-second MAC expiration time to make it easier to see what's going on
 879  *
 880  *      ovs-vsctl del-controller br0
 881  *      ovs-ofctl del-flows br0
 882  *      ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
 883           hard_timeout=10, NXM_OF_VLAN_TCI[0..11],             \
 884           NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],                   \
 885           output:NXM_OF_IN_PORT[]), resubmit(,1)"
 886  *      ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
 887  *
 888  *    You can then dump the MAC learning table with:
 889  *
 890  *      ovs-ofctl dump-flows br0 table=1
 891  *
 892  * Usage Advice
 893  * ------------
 894  *
 895  * For best performance, segregate learned flows into a table that is not used
 896  * for any other flows except possibly for a lowest-priority "catch-all" flow
 897  * (a flow with no match criteria).  If different learning actions specify
 898  * different match criteria, use different tables for the learned flows.
 899  *
 900  * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
 901  * These timeouts apply to the flow that is added, which means that a flow with
 902  * an idle timeout will expire when no traffic has been sent *to* the learned
 903  * address.  This is not usually the intent in MAC learning; instead, we want
 904  * the MAC learn entry to expire when no traffic has been sent *from* the
 905  * learned address.  Use a hard timeout for that.
 906  */
 907 struct nx_action_learn {
 908     ovs_be16 type;              /* OFPAT_VENDOR. */
 909     ovs_be16 len;               /* At least 24. */
 910     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 911     ovs_be16 subtype;           /* NXAST_LEARN. */
 912     ovs_be16 idle_timeout;      /* Idle time before discarding (seconds). */
 913     ovs_be16 hard_timeout;      /* Max time before discarding (seconds). */
 914     ovs_be16 priority;          /* Priority level of flow entry. */
 915     ovs_be64 cookie;            /* Cookie for new flow. */
 916     ovs_be16 flags;             /* Either 0 or OFPFF_SEND_FLOW_REM. */
 917     uint8_t table_id;           /* Table to insert flow entry. */
 918     uint8_t pad;                /* Must be zero. */
 919     ovs_be16 fin_idle_timeout;  /* Idle timeout after FIN, if nonzero. */
 920     ovs_be16 fin_hard_timeout;  /* Hard timeout after FIN, if nonzero. */
 921     /* Followed by a sequence of flow_mod_spec elements, as described above,
 922      * until the end of the action is reached. */
 923 };
 924 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
 925
 926 #define NX_LEARN_N_BITS_MASK    0x3ff
 927
 928 #define NX_LEARN_SRC_FIELD     (0 << 13) /* Copy from field. */
 929 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
 930 #define NX_LEARN_SRC_MASK      (1 << 13)
 931
 932 #define NX_LEARN_DST_MATCH     (0 << 11) /* Add match criterion. */
 933 #define NX_LEARN_DST_LOAD      (1 << 11) /* Add NXAST_REG_LOAD action. */
 934 #define NX_LEARN_DST_OUTPUT    (2 << 11) /* Add OFPAT_OUTPUT action. */
 935 #define NX_LEARN_DST_RESERVED  (3 << 11) /* Not yet defined. */
 936 #define NX_LEARN_DST_MASK      (3 << 11)
 937
 938 /* Action structure for NXAST_FIN_TIMEOUT.
 939  *
 940  * This action changes the idle timeout or hard timeout, or both, of this
 941  * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
 942  * When such a packet is observed, the action reduces the rule's idle timeout
 943  * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'.  This
 944  * action has no effect on an existing timeout that is already shorter than the
 945  * one that the action specifies.  A 'fin_idle_timeout' or 'fin_hard_timeout'
 946  * of zero has no effect on the respective timeout.
 947  *
 948  * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
 949  * 'fin_hard_timeout' specifies time since the flow's creation, not since the
 950  * receipt of the FIN or RST.
 951  *
 952  * This is useful for quickly discarding learned TCP flows that otherwise will
 953  * take a long time to expire.
 954  *
 955  * This action is intended for use with an OpenFlow rule that matches only a
 956  * single TCP flow.  If the rule matches multiple TCP flows (e.g. it wildcards
 957  * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
 958  * RST in any of those flows will cause the entire OpenFlow rule to expire
 959  * early, which is not normally desirable.
 960  */
 961 struct nx_action_fin_timeout {
 962     ovs_be16 type;              /* OFPAT_VENDOR. */
 963     ovs_be16 len;               /* 16. */
 964     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 965     ovs_be16 subtype;           /* NXAST_FIN_TIMEOUT. */
 966     ovs_be16 fin_idle_timeout;  /* New idle timeout, if nonzero. */
 967     ovs_be16 fin_hard_timeout;  /* New hard timeout, if nonzero. */
 968     ovs_be16 pad;               /* Must be zero. */
 969 };
 970 OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
 971 \f
 972 /* Action structure for NXAST_AUTOPATH.
 973  *
 974  * This action performs the following steps in sequence:
 975  *
 976  *    1. Hashes the flow using an implementation-defined hash function.
 977  *
 978  *       The hashed fields' values are drawn from the current state of the
 979  *       flow, including all modifications that have been made by actions up to
 980  *       this point.
 981  *
 982  *    2. Selects an OpenFlow 'port'.
 983  *
 984  *       'port' is selected in an implementation-defined manner, taking into
 985  *       account 'id' and the hash value calculated in step 1.
 986  *
 987  *       Generally a switch will have been configured with a set of ports that
 988  *       may be chosen given 'id'.  The switch may take into account any number
 989  *       of factors when choosing 'port' from its configured set.  Factors may
 990  *       include carrier, load, and the results of configuration protocols such
 991  *       as LACP.
 992  *
 993  *    3. Stores 'port' in dst[ofs:ofs+n_bits].
 994  *
 995  *       The format and semantics of 'dst' and 'ofs_nbits' are similar to those
 996  *       for the NXAST_REG_LOAD action.
 997  *
 998  * The switch will reject actions in which ofs+n_bits is greater than the width
 999  * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
1000  */
1001 struct nx_action_autopath {
1002     ovs_be16 type;              /* OFPAT_VENDOR. */
1003     ovs_be16 len;               /* Length is 20. */
1004     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1005     ovs_be16 subtype;           /* NXAST_AUTOPATH. */
1006
1007     /* Where to store the result. */
1008     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1009     ovs_be32 dst;               /* Destination. */
1010
1011     ovs_be32 id;                /* Autopath ID. */
1012     ovs_be32 pad;
1013 };
1014 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
1015 \f
1016 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
1017  *
1018  * The bundle actions choose a slave from a supplied list of options.
1019  * NXAST_BUNDLE outputs to its selection.  NXAST_BUNDLE_LOAD writes its
1020  * selection to a register.
1021  *
1022  * The list of possible slaves follows the nx_action_bundle structure. The size
1023  * of each slave is governed by its type as indicated by the 'slave_type'
1024  * parameter. The list of slaves should be padded at its end with zeros to make
1025  * the total length of the action a multiple of 8.
1026  *
1027  * Switches infer from the 'slave_type' parameter the size of each slave.  All
1028  * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
1029  * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
1030  * 2 byte width.  Switches should reject actions which indicate unknown or
1031  * unsupported slave types.
1032  *
1033  * Switches use a strategy dictated by the 'algorithm' parameter to choose a
1034  * slave.  If the switch does not support the specified 'algorithm' parameter,
1035  * it should reject the action.
1036  *
1037  * Several algorithms take into account liveness when selecting slaves.  The
1038  * liveness of a slave is implementation defined (with one exception), but will
1039  * generally take into account things like its carrier status and the results
1040  * of any link monitoring protocols which happen to be running on it.  In order
1041  * to give controllers a place-holder value, the OFPP_NONE port is always
1042  * considered live.
1043  *
1044  * Some slave selection strategies require the use of a hash function, in which
1045  * case the 'fields' and 'basis' parameters should be populated.  The 'fields'
1046  * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1047  * hash.  Refer to the definition of "enum nx_hash_fields" for details.  The
1048  * 'basis' parameter is used as a universal hash parameter.  Different values
1049  * of 'basis' yield different hash results.
1050  *
1051  * The 'zero' parameter at the end of the action structure is reserved for
1052  * future use.  Switches are required to reject actions which have nonzero
1053  * bytes in the 'zero' field.
1054  *
1055  * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed.  Switches
1056  * should reject actions which have nonzero bytes in either of these fields.
1057  *
1058  * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1059  * dst[ofs:ofs+n_bits].  The format and semantics of 'dst' and 'ofs_nbits' are
1060  * similar to those for the NXAST_REG_LOAD action. */
1061 struct nx_action_bundle {
1062     ovs_be16 type;              /* OFPAT_VENDOR. */
1063     ovs_be16 len;               /* Length including slaves. */
1064     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1065     ovs_be16 subtype;           /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1066
1067     /* Slave choice algorithm to apply to hash value. */
1068     ovs_be16 algorithm;         /* One of NX_BD_ALG_*. */
1069
1070     /* What fields to hash and how. */
1071     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
1072     ovs_be16 basis;             /* Universal hash parameter. */
1073
1074     ovs_be32 slave_type;        /* NXM_OF_IN_PORT. */
1075     ovs_be16 n_slaves;          /* Number of slaves. */
1076
1077     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1078     ovs_be32 dst;               /* Destination. */
1079
1080     uint8_t zero[4];            /* Reserved. Must be zero. */
1081 };
1082 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1083
1084 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1085  *
1086  * In the descriptions below, 'slaves' is the list of possible slaves in the
1087  * order they appear in the OpenFlow action. */
1088 enum nx_bd_algorithm {
1089     /* Chooses the first live slave listed in the bundle.
1090      *
1091      * O(n_slaves) performance. */
1092     NX_BD_ALG_ACTIVE_BACKUP,
1093
1094     /* for i in [0,n_slaves):
1095      *   weights[i] = hash(flow, i)
1096      * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1097      *
1098      * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1099      * O(n_slaves) performance.
1100      *
1101      * Uses the 'fields' and 'basis' parameters. */
1102     NX_BD_ALG_HRW /* Highest Random Weight. */
1103 };
1104 \f
1105 /* Action structure for NXAST_OUTPUT_REG.
1106  *
1107  * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1108  *
1109  * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1110  * the NXAST_REG_LOAD action.
1111  *
1112  * The acceptable nxm_header values for 'src' are the same as the acceptable
1113  * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1114  *
1115  * The 'max_len' field indicates the number of bytes to send when the chosen
1116  * port is OFPP_CONTROLLER.  Its semantics are equivalent to the 'max_len'
1117  * field of OFPAT_OUTPUT.
1118  *
1119  * The 'zero' field is required to be zeroed for forward compatibility. */
1120 struct nx_action_output_reg {
1121     ovs_be16 type;              /* OFPAT_VENDOR. */
1122     ovs_be16 len;               /* 24. */
1123     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1124     ovs_be16 subtype;           /* NXAST_OUTPUT_REG. */
1125
1126     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1127     ovs_be32 src;               /* Source. */
1128
1129     ovs_be16 max_len;           /* Max length to send to controller. */
1130
1131     uint8_t zero[6];            /* Reserved, must be zero. */
1132 };
1133 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1134 \f
1135 /* NXAST_EXIT
1136  *
1137  * Discontinues action processing.
1138  *
1139  * The NXAST_EXIT action causes the switch to immediately halt processing
1140  * actions for the flow.  Any actions which have already been processed are
1141  * executed by the switch.  However, any further actions, including those which
1142  * may be in different tables, or different levels of the NXAST_RESUBMIT
1143  * hierarchy, will be ignored.
1144  *
1145  * Uses the nx_action_header structure. */
1146 \f
1147 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1148  *
1149  * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches.  This
1150  * structure is fixed-length and hence difficult to extend.  This section
1151  * describes a more flexible, variable-length flow match, called "nx_match" for
1152  * short, that is also supported by Open vSwitch.  This section also defines a
1153  * replacement for each OpenFlow message that includes struct ofp_match.
1154  *
1155  *
1156  * Format
1157  * ======
1158  *
1159  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1160  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1161  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
1162  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1163  * "body".
1164  *
1165  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1166  *
1167  * |<-------------------- nxm_type ------------------>|
1168  * |                                                  |
1169  * |31                              16 15            9| 8 7                0
1170  * +----------------------------------+---------------+--+------------------+
1171  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
1172  * +----------------------------------+---------------+--+------------------+
1173  *
1174  * The most-significant 23 bits of the header are collectively "nxm_type".
1175  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
1176  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
1177  * designates a protocol header, such as the Ethernet type, but it can also
1178  * refer to packet metadata, such as the switch port on which a packet arrived.
1179  *
1180  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
1181  * of this bit is explained later.
1182  *
1183  * The least-significant 8 bits are "nxm_length", a positive integer.  The
1184  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1185  * bytes.
1186  *
1187  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1188  * constant.  It is included only to allow software to minimally parse
1189  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
1190  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1191  *
1192  *
1193  * Semantics
1194  * =========
1195  *
1196  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1197  *
1198  * An nxm_entry places a constraint on the packets matched by the nx_match:
1199  *
1200  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1201  *     field, called "nxm_value".  The nx_match matches only packets in which
1202  *     the field equals nxm_value.
1203  *
1204  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1205  *     field (nxm_value), followed by a bitmask of the same length as the
1206  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
1207  *     nx_match matches only packets for which bit J in the given field's value
1208  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
1209  *     corresponding bits in nxm_value and the field's value to be ignored.
1210  *     (The sense of the nxm_mask bits is the opposite of that used by the
1211  *     "wildcards" member of struct ofp_match.)
1212  *
1213  *     When nxm_hasmask is 1, nxm_length is always even.
1214  *
1215  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1216  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
1217  *     nxm_hasmask.
1218  *
1219  * When there are multiple "nxm_entry"s, all of the constraints must be met.
1220  *
1221  *
1222  * Mask Restrictions
1223  * =================
1224  *
1225  * Masks may be restricted:
1226  *
1227  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1228  *     must always be 0 when these fields are specified.  For example, the
1229  *     field that identifies the port on which a packet was received may not be
1230  *     masked.
1231  *
1232  *   - Some nxm_types that do support masked wildcards may only support certain
1233  *     nxm_mask patterns.  For example, fields that have IPv4 address values
1234  *     may be restricted to CIDR masks.
1235  *
1236  * These restrictions should be noted in specifications for individual fields.
1237  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1238  * disallows, if the switch correctly implements support for that nxm_hasmask
1239  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
1240  * contains a nxm_hasmask or nxm_mask value that it does not support.
1241  *
1242  *
1243  * Prerequisite Restrictions
1244  * =========================
1245  *
1246  * The presence of an nxm_entry with a given nxm_type may be restricted based
1247  * on the presence of or values of other "nxm_entry"s.  For example:
1248  *
1249  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1250  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1251  *     and nxm_value=0x0800.  That is, matching on the IP source address is
1252  *     allowed only if the Ethernet type is explicitly set to IP.
1253  *
1254  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1255  *     preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1256  *     nxm_value either 0x0800 or 0x86dd, and another with
1257  *     nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1258  *     That is, matching on the TCP source port is allowed only if the Ethernet
1259  *     type is IP or IPv6 and the IP protocol is TCP.
1260  *
1261  * These restrictions should be noted in specifications for individual fields.
1262  * A switch may implement relaxed versions of these restrictions.  A switch
1263  * must reject an attempt to set up a flow that violates its restrictions.
1264  *
1265  *
1266  * Ordering Restrictions
1267  * =====================
1268  *
1269  * An nxm_entry that has prerequisite restrictions must appear after the
1270  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
1271  * nx_match is not otherwise constrained.
1272  *
1273  * Any given nxm_type may appear in an nx_match at most once.
1274  *
1275  *
1276  * nxm_entry Examples
1277  * ==================
1278  *
1279  * These examples show the format of a single nxm_entry with particular
1280  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
1281  * numbers and byte indexes.
1282  *
1283  *
1284  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1285  *
1286  *  0          3  4   5
1287  * +------------+---+---+
1288  * |   header   | v | m |
1289  * +------------+---+---+
1290  *
1291  *
1292  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1293  *
1294  *  0          3 4    5
1295  * +------------+------+
1296  * |   header   | value|
1297  * +------------+------+
1298  *
1299  *
1300  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1301  *
1302  *  0          3 4           7
1303  * +------------+-------------+
1304  * |   header   |  nxm_value  |
1305  * +------------+-------------+
1306  *
1307  *
1308  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1309  *
1310  *  0          3 4                9
1311  * +------------+------------------+
1312  * |   header   |     nxm_value    |
1313  * +------------+------------------+
1314  *
1315  *
1316  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1317  *
1318  *  0          3 4                9 10              15
1319  * +------------+------------------+------------------+
1320  * |   header   |     nxm_value    |      nxm_mask    |
1321  * +------------+------------------+------------------+
1322  *
1323  *
1324  * Error Reporting
1325  * ===============
1326  *
1327  * A switch should report an error in an nx_match using error type
1328  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
1329  * should report a specific error code, if one is assigned for the particular
1330  * problem, but NXBRC_NXM_INVALID is also available to report a generic
1331  * nx_match error.
1332  */
1333
1334 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1335     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1336 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1337     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1338 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1339     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1340 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1341 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1342 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1343 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1344 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1345
1346 #define NXM_MAKE_WILD_HEADER(HEADER) \
1347         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1348
1349 /* ## ------------------------------- ## */
1350 /* ## OpenFlow 1.0-compatible fields. ## */
1351 /* ## ------------------------------- ## */
1352
1353 /* Physical or virtual port on which the packet was received.
1354  *
1355  * Prereqs: None.
1356  *
1357  * Format: 16-bit integer in network byte order.
1358  *
1359  * Masking: Not maskable. */
1360 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
1361
1362 /* Source or destination address in Ethernet header.
1363  *
1364  * Prereqs: None.
1365  *
1366  * Format: 48-bit Ethernet MAC address.
1367  *
1368  * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1369  *   be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1370  *   are all-0-bits or all-1-bits).  Support for other patterns and for masking
1371  *   of NXM_OF_ETH_SRC is optional. */
1372 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
1373 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
1374 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
1375
1376 /* Packet's Ethernet type.
1377  *
1378  * For an Ethernet II packet this is taken from the Ethernet header.  For an
1379  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1380  * A packet that has neither format has value 0x05ff
1381  * (OFP_DL_TYPE_NOT_ETH_TYPE).
1382  *
1383  * For a packet with an 802.1Q header, this is the type of the encapsulated
1384  * frame.
1385  *
1386  * Prereqs: None.
1387  *
1388  * Format: 16-bit integer in network byte order.
1389  *
1390  * Masking: Not maskable. */
1391 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
1392
1393 /* 802.1Q TCI.
1394  *
1395  * For a packet with an 802.1Q header, this is the Tag Control Information
1396  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
1397  * header, this has value 0.
1398  *
1399  * Prereqs: None.
1400  *
1401  * Format: 16-bit integer in network byte order.
1402  *
1403  * Masking: Arbitrary masks.
1404  *
1405  * This field can be used in various ways:
1406  *
1407  *   - If it is not constrained at all, the nx_match matches packets without
1408  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
1409  *
1410  *   - Testing for an exact match with 0 matches only packets without an
1411  *     802.1Q header.
1412  *
1413  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
1414  *     that have an 802.1Q header with a specified VID and PCP.
1415  *
1416  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
1417  *     not make sense.  The switch may reject this combination.
1418  *
1419  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1420  *     packets that have an 802.1Q header with that VID (and any PCP).
1421  *
1422  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1423  *     packets that have an 802.1Q header with that PCP (and any VID).
1424  *
1425  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1426  *     header or with an 802.1Q header with a VID of 0.
1427  *
1428  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1429  *     header or with an 802.1Q header with a PCP of 0.
1430  *
1431  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1432  *     header or with an 802.1Q header with both VID and PCP of 0.
1433  */
1434 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
1435 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
1436
1437 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1438  *
1439  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1440  *
1441  * Format: 8-bit integer with 2 least-significant bits forced to 0.
1442  *
1443  * Masking: Not maskable. */
1444 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
1445
1446 /* The "protocol" byte in the IP header.
1447  *
1448  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1449  *
1450  * Format: 8-bit integer.
1451  *
1452  * Masking: Not maskable. */
1453 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
1454
1455 /* The source or destination address in the IP header.
1456  *
1457  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1458  *
1459  * Format: 32-bit integer in network byte order.
1460  *
1461  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1462  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1463 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
1464 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
1465 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
1466 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
1467
1468 /* The source or destination port in the TCP header.
1469  *
1470  * Prereqs:
1471  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1472  *   NXM_OF_IP_PROTO must match 6 exactly.
1473  *
1474  * Format: 16-bit integer in network byte order.
1475  *
1476  * Masking: Fully maskable, in Open vSwitch 1.6 and later.  Not maskable, in
1477  *   earlier versions. */
1478 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
1479 #define NXM_OF_TCP_SRC_W  NXM_HEADER_W(0x0000,  9, 2)
1480 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
1481 #define NXM_OF_TCP_DST_W  NXM_HEADER_W(0x0000, 10, 2)
1482
1483 /* The source or destination port in the UDP header.
1484  *
1485  * Prereqs:
1486  *   NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1487  *   NXM_OF_IP_PROTO must match 17 exactly.
1488  *
1489  * Format: 16-bit integer in network byte order.
1490  *
1491  * Masking: Fully maskable, in Open vSwitch 1.6 and later.  Not maskable, in
1492  *   earlier versions. */
1493 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
1494 #define NXM_OF_UDP_SRC_W  NXM_HEADER_W(0x0000, 11, 2)
1495 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
1496 #define NXM_OF_UDP_DST_W  NXM_HEADER_W(0x0000, 12, 2)
1497
1498 /* The type or code in the ICMP header.
1499  *
1500  * Prereqs:
1501  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
1502  *   NXM_OF_IP_PROTO must match 1 exactly.
1503  *
1504  * Format: 8-bit integer.
1505  *
1506  * Masking: Not maskable. */
1507 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
1508 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
1509
1510 /* ARP opcode.
1511  *
1512  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1513  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1514  * matching.
1515  *
1516  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1517  *
1518  * Format: 16-bit integer in network byte order.
1519  *
1520  * Masking: Not maskable. */
1521 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
1522
1523 /* For an Ethernet+IP ARP packet, the source or target protocol address
1524  * in the ARP header.  Always 0 otherwise.
1525  *
1526  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1527  *
1528  * Format: 32-bit integer in network byte order.
1529  *
1530  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1531  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1532 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
1533 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
1534 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
1535 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
1536
1537 /* ## ------------------------ ## */
1538 /* ## Nicira match extensions. ## */
1539 /* ## ------------------------ ## */
1540
1541 /* Metadata registers.
1542  *
1543  * Registers initially have value 0.  Actions allow register values to be
1544  * manipulated.
1545  *
1546  * Prereqs: None.
1547  *
1548  * Format: Array of 32-bit integer registers.  Space is reserved for up to
1549  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
1550  *
1551  * Masking: Arbitrary masks. */
1552 #define NXM_NX_MAX_REGS 16
1553 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
1554 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1555 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1556 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1557 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1558 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
1559 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
1560 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
1561 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
1562 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
1563 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
1564 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
1565 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
1566 #define NXM_NX_REG4       NXM_HEADER  (0x0001, 4, 4)
1567 #define NXM_NX_REG4_W     NXM_HEADER_W(0x0001, 4, 4)
1568
1569 /* Tunnel ID.
1570  *
1571  * For a packet received via GRE tunnel including a (32-bit) key, the key is
1572  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
1573  * the value is 0.
1574  *
1575  * Prereqs: None.
1576  *
1577  * Format: 64-bit integer in network byte order.
1578  *
1579  * Masking: Arbitrary masks. */
1580 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
1581 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
1582
1583 /* For an Ethernet+IP ARP packet, the source or target hardware address
1584  * in the ARP header.  Always 0 otherwise.
1585  *
1586  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1587  *
1588  * Format: 48-bit Ethernet MAC address.
1589  *
1590  * Masking: Not maskable. */
1591 #define NXM_NX_ARP_SHA    NXM_HEADER  (0x0001, 17, 6)
1592 #define NXM_NX_ARP_THA    NXM_HEADER  (0x0001, 18, 6)
1593
1594 /* The source or destination address in the IPv6 header.
1595  *
1596  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1597  *
1598  * Format: 128-bit IPv6 address.
1599  *
1600  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1601  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1602 #define NXM_NX_IPV6_SRC    NXM_HEADER  (0x0001, 19, 16)
1603 #define NXM_NX_IPV6_SRC_W  NXM_HEADER_W(0x0001, 19, 16)
1604 #define NXM_NX_IPV6_DST    NXM_HEADER  (0x0001, 20, 16)
1605 #define NXM_NX_IPV6_DST_W  NXM_HEADER_W(0x0001, 20, 16)
1606
1607 /* The type or code in the ICMPv6 header.
1608  *
1609  * Prereqs:
1610  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1611  *   NXM_OF_IP_PROTO must match 58 exactly.
1612  *
1613  * Format: 8-bit integer.
1614  *
1615  * Masking: Not maskable. */
1616 #define NXM_NX_ICMPV6_TYPE NXM_HEADER  (0x0001, 21, 1)
1617 #define NXM_NX_ICMPV6_CODE NXM_HEADER  (0x0001, 22, 1)
1618
1619 /* The target address in an IPv6 Neighbor Discovery message.
1620  *
1621  * Prereqs:
1622  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1623  *   NXM_OF_IP_PROTO must match 58 exactly.
1624  *   NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1625  *
1626  * Format: 128-bit IPv6 address.
1627  *
1628  * Masking: Not maskable. */
1629 #define NXM_NX_ND_TARGET   NXM_HEADER  (0x0001, 23, 16)
1630
1631 /* The source link-layer address option in an IPv6 Neighbor Discovery
1632  * message.
1633  *
1634  * Prereqs:
1635  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1636  *   NXM_OF_IP_PROTO must match 58 exactly.
1637  *   NXM_OF_ICMPV6_TYPE must be exactly 135.
1638  *
1639  * Format: 48-bit Ethernet MAC address.
1640  *
1641  * Masking: Not maskable. */
1642 #define NXM_NX_ND_SLL      NXM_HEADER  (0x0001, 24, 6)
1643
1644 /* The target link-layer address option in an IPv6 Neighbor Discovery
1645  * message.
1646  *
1647  * Prereqs:
1648  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1649  *   NXM_OF_IP_PROTO must match 58 exactly.
1650  *   NXM_OF_ICMPV6_TYPE must be exactly 136.
1651  *
1652  * Format: 48-bit Ethernet MAC address.
1653  *
1654  * Masking: Not maskable. */
1655 #define NXM_NX_ND_TLL      NXM_HEADER  (0x0001, 25, 6)
1656
1657 /* IP fragment information.
1658  *
1659  * Prereqs:
1660  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1661  *
1662  * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1663  *
1664  * Masking: Fully maskable.
1665  *
1666  * This field has three possible values:
1667  *
1668  *   - A packet that is not an IP fragment has value 0.
1669  *
1670  *   - A packet that is an IP fragment with offset 0 (the first fragment) has
1671  *     bit 0 set and thus value 1.
1672  *
1673  *   - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1674  *     and thus value 3.
1675  *
1676  * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1677  * the meanings of bits 0 and 1.
1678  *
1679  * The switch may reject matches against values that can never appear.
1680  *
1681  * It is important to understand how this field interacts with the OpenFlow IP
1682  * fragment handling mode:
1683  *
1684  *   - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1685  *     before they reach the flow table, so every packet that is available for
1686  *     matching will have value 0 in this field.
1687  *
1688  *   - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1689  *     IP fragments would be reassembled before they reached the flow table and
1690  *     again every packet available for matching would always have value 0.
1691  *
1692  *   - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1693  *     1.0 says that fragments' transport ports are always 0, even for the
1694  *     first fragment, so this does not provide much extra information.
1695  *
1696  *   - In OFPC_FRAG_NX_MATCH mode, all three values are possible.  For
1697  *     fragments with offset 0, Open vSwitch makes L4 header information
1698  *     available.
1699  */
1700 #define NXM_NX_IP_FRAG     NXM_HEADER  (0x0001, 26, 1)
1701 #define NXM_NX_IP_FRAG_W   NXM_HEADER_W(0x0001, 26, 1)
1702
1703 /* Bits in the value of NXM_NX_IP_FRAG. */
1704 #define NX_IP_FRAG_ANY   (1 << 0) /* Is this a fragment? */
1705 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1706
1707 /* The flow label in the IPv6 header.
1708  *
1709  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1710  *
1711  * Format: 20-bit IPv6 flow label in least-significant bits.
1712  *
1713  * Masking: Not maskable. */
1714 #define NXM_NX_IPV6_LABEL  NXM_HEADER  (0x0001, 27, 4)
1715
1716 /* The ECN of the IP header.
1717  *
1718  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1719  *
1720  * Format: ECN in the low-order 2 bits.
1721  *
1722  * Masking: Not maskable. */
1723 #define NXM_NX_IP_ECN      NXM_HEADER  (0x0001, 28, 1)
1724
1725 /* The time-to-live/hop limit of the IP header.
1726  *
1727  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1728  *
1729  * Format: 8-bit integer.
1730  *
1731  * Masking: Not maskable. */
1732 #define NXM_NX_IP_TTL      NXM_HEADER  (0x0001, 29, 1)
1733
1734 /* Flow cookie.
1735  *
1736  * This may be used to gain the OpenFlow 1.1-like ability to restrict
1737  * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1738  * with specific cookies.  See the "nx_flow_mod" and "nx_flow_stats_request"
1739  * structure definitions for more details.  This match is otherwise not
1740  * allowed.
1741  *
1742  * Prereqs: None.
1743  *
1744  * Format: 64-bit integer in network byte order.
1745  *
1746  * Masking: Arbitrary masks. */
1747 #define NXM_NX_COOKIE     NXM_HEADER  (0x0001, 30, 8)
1748 #define NXM_NX_COOKIE_W   NXM_HEADER_W(0x0001, 30, 8)
1749
1750 /* ## --------------------- ## */
1751 /* ## Requests and replies. ## */
1752 /* ## --------------------- ## */
1753
1754 enum nx_flow_format {
1755     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
1756     NXFF_NXM = 2                 /* Nicira extended match. */
1757 };
1758
1759 /* NXT_SET_FLOW_FORMAT request. */
1760 struct nx_set_flow_format {
1761     struct ofp_header header;
1762     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1763     ovs_be32 subtype;           /* NXT_SET_FLOW_FORMAT. */
1764     ovs_be32 format;            /* One of NXFF_*. */
1765 };
1766 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 20);
1767
1768 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1769  *
1770  * It is possible to limit flow deletions and modifications to certain
1771  * cookies by using the NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.  For
1772  * these commands, the "cookie" field is always ignored.  Flow additions
1773  * make use of the "cookie" field and ignore any NXM_NX_COOKIE*
1774  * definitions.
1775  */
1776 struct nx_flow_mod {
1777     struct nicira_header nxh;
1778     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
1779     ovs_be16 command;             /* One of OFPFC_*. */
1780     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
1781     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
1782     ovs_be16 priority;            /* Priority level of flow entry. */
1783     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
1784                                      Not meaningful for OFPFC_DELETE*. */
1785     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
1786                                      matching entries to include this as an
1787                                      output port.  A value of OFPP_NONE
1788                                      indicates no restriction. */
1789     ovs_be16 flags;               /* One of OFPFF_*. */
1790     ovs_be16 match_len;           /* Size of nx_match. */
1791     uint8_t pad[6];               /* Align to 64-bits. */
1792     /* Followed by:
1793      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1794      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1795      *     all-zero bytes, then
1796      *   - Actions to fill out the remainder of the message length (always a
1797      *     multiple of 8).
1798      */
1799 };
1800 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1801
1802 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1803 struct nx_flow_removed {
1804     struct nicira_header nxh;
1805     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1806     ovs_be16 priority;        /* Priority level of flow entry. */
1807     uint8_t reason;           /* One of OFPRR_*. */
1808     uint8_t pad[1];           /* Align to 32-bits. */
1809     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
1810     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
1811                                  duration_sec. */
1812     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
1813     ovs_be16 match_len;       /* Size of nx_match. */
1814     ovs_be64 packet_count;
1815     ovs_be64 byte_count;
1816     /* Followed by:
1817      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1818      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1819      *     all-zero bytes. */
1820 };
1821 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1822
1823 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1824  * request).
1825  *
1826  * It is possible to limit matches to certain cookies by using the
1827  * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1828  */
1829 struct nx_flow_stats_request {
1830     struct nicira_stats_msg nsm;
1831     ovs_be16 out_port;        /* Require matching entries to include this
1832                                  as an output port.  A value of OFPP_NONE
1833                                  indicates no restriction. */
1834     ovs_be16 match_len;       /* Length of nx_match. */
1835     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1836                                  or 0xff for all tables. */
1837     uint8_t pad[3];           /* Align to 64 bits. */
1838     /* Followed by:
1839      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1840      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1841      *     all-zero bytes, which must also exactly fill out the length of the
1842      *     message.
1843      */
1844 };
1845 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1846
1847 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1848  * OFPST_FLOW reply).
1849  *
1850  * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
1851  * a switch that implements the NXT_FLOW_AGE extension.  Zero means that the
1852  * true value is unknown, perhaps because hardware does not track the value.
1853  * (Zero is also the value that one should ordinarily expect to see talking to
1854  * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
1855  * padding bytes that these fields replaced.)  A nonzero value X represents X-1
1856  * seconds.  A value of 65535 represents 65534 or more seconds.
1857  *
1858  * 'idle_age' is the number of seconds that the flow has been idle, that is,
1859  * the number of seconds since a packet passed through the flow.  'hard_age' is
1860  * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
1861  * OFPFC_MODIFY_STRICT).  (The 'duration_*' fields are the elapsed time since
1862  * the flow was added, regardless of subsequent modifications.)
1863  *
1864  * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
1865  * respectively, will ordinarily be smaller than the timeout, but flow
1866  * expiration times are only approximate and so one must be prepared to
1867  * tolerate expirations that occur somewhat early or late.
1868  */
1869 struct nx_flow_stats {
1870     ovs_be16 length;          /* Length of this entry. */
1871     uint8_t table_id;         /* ID of table flow came from. */
1872     uint8_t pad;
1873     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1874     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1875                                  beyond duration_sec. */
1876     ovs_be16 priority;        /* Priority of the entry. Only meaningful
1877                                  when this is not an exact-match entry. */
1878     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1879     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1880     ovs_be16 match_len;       /* Length of nx_match. */
1881     ovs_be16 idle_age;        /* Seconds since last packet, plus one. */
1882     ovs_be16 hard_age;        /* Seconds since last modification, plus one. */
1883     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1884     ovs_be64 packet_count;    /* Number of packets, UINT64_MAX if unknown. */
1885     ovs_be64 byte_count;      /* Number of bytes, UINT64_MAX if unknown. */
1886     /* Followed by:
1887      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1888      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1889      *     all-zero bytes, then
1890      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1891      *     of 8).
1892      */
1893 };
1894 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1895
1896 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1897  * OFPST_AGGREGATE request). */
1898 struct nx_aggregate_stats_request {
1899     struct nicira_stats_msg nsm;
1900     ovs_be16 out_port;        /* Require matching entries to include this
1901                                  as an output port.  A value of OFPP_NONE
1902                                  indicates no restriction. */
1903     ovs_be16 match_len;       /* Length of nx_match. */
1904     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1905                                  or 0xff for all tables. */
1906     uint8_t pad[3];           /* Align to 64 bits. */
1907     /* Followed by:
1908      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1909      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1910      *     all-zero bytes, which must also exactly fill out the length of the
1911      *     message.
1912      */
1913 };
1914 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1915
1916 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1917  * OFPST_AGGREGATE reply). */
1918 struct nx_aggregate_stats_reply {
1919     struct nicira_stats_msg nsm;
1920     ovs_be64 packet_count;     /* Number of packets, UINT64_MAX if unknown. */
1921     ovs_be64 byte_count;       /* Number of bytes, UINT64_MAX if unknown. */
1922     ovs_be32 flow_count;       /* Number of flows. */
1923     uint8_t pad[4];            /* Align to 64 bits. */
1924 };
1925 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1926 \f
1927 /* NXT_SET_CONTROLLER_ID.
1928  *
1929  * Each OpenFlow controller connection has a 16-bit identifier that is
1930  * initially 0.  This message changes the connection's ID to 'id'.
1931  *
1932  * Controller connection IDs need not be unique.
1933  *
1934  * The NXAST_CONTROLLER action is the only current user of controller
1935  * connection IDs. */
1936 struct nx_controller_id {
1937     struct nicira_header nxh;
1938     uint8_t zero[6];            /* Must be zero. */
1939     ovs_be16 controller_id;     /* New controller connection ID. */
1940 };
1941 OFP_ASSERT(sizeof(struct nx_controller_id) == 24);
1942
1943 /* Action structure for NXAST_CONTROLLER.
1944  *
1945  * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER.  In
1946  * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
1947  * specifying:
1948  *
1949  *    - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
1950  *
1951  *    - 'controller_id': The ID of the controller connection to which the
1952  *      ofp_packet_in should be sent.  The ofp_packet_in or nx_packet_in is
1953  *      sent only to controllers that have the specified controller connection
1954  *      ID.  See "struct nx_controller_id" for more information. */
1955 struct nx_action_controller {
1956     ovs_be16 type;                  /* OFPAT_VENDOR. */
1957     ovs_be16 len;                   /* Length is 16. */
1958     ovs_be32 vendor;                /* NX_VENDOR_ID. */
1959     ovs_be16 subtype;               /* NXAST_CONTROLLER. */
1960     ovs_be16 max_len;               /* Maximum length to send to controller. */
1961     ovs_be16 controller_id;         /* Controller ID to send packet-in. */
1962     uint8_t reason;                 /* enum ofp_packet_in_reason (OFPR_*). */
1963     uint8_t zero;                   /* Must be zero. */
1964 };
1965 OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
1966
1967 #endif /* openflow/nicira-ext.h */