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