include/openflow/nicira-ext.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OPENFLOW_NICIRA_EXT_H
  18 #define OPENFLOW_NICIRA_EXT_H 1
  19
  20 #include "openflow/openflow.h"
  21
  22 #define NICIRA_OUI_STR "002320"
  23
  24 /* The following vendor extensions, proposed by Nicira Networks, are not yet
  25  * ready for standardization (and may never be), so they are not included in
  26  * openflow.h. */
  27
  28 #define NX_VENDOR_ID 0x00002320
  29
  30 enum nicira_type {
  31     /* Switch status request.  The request body is an ASCII string that
  32      * specifies a prefix of the key names to include in the output; if it is
  33      * the null string, then all key-value pairs are included. */
  34     NXT_STATUS_REQUEST,
  35
  36     /* Switch status reply.  The reply body is an ASCII string of key-value
  37      * pairs in the form "key=value\n". */
  38     NXT_STATUS_REPLY,
  39
  40     /* No longer used. */
  41     NXT_ACT_SET_CONFIG__OBSOLETE,
  42     NXT_ACT_GET_CONFIG__OBSOLETE,
  43     NXT_COMMAND_REQUEST__OBSOLETE,
  44     NXT_COMMAND_REPLY__OBSOLETE,
  45     NXT_FLOW_END_CONFIG__OBSOLETE,
  46     NXT_FLOW_END__OBSOLETE,
  47     NXT_MGMT__OBSOLETE,
  48 };
  49
  50 struct nicira_header {
  51     struct ofp_header header;
  52     uint32_t vendor;            /* NX_VENDOR_ID. */
  53     uint32_t subtype;           /* One of NXT_* above. */
  54 };
  55 OFP_ASSERT(sizeof(struct nicira_header) == 16);
  56
  57
  58 enum nx_action_subtype {
  59     NXAST_SNAT__OBSOLETE,           /* No longer used. */
  60
  61     /* Searches the flow table again, using a flow that is slightly modified
  62      * from the original lookup:
  63      *
  64      *    - The 'in_port' member of struct nx_action_resubmit is used as the
  65      *      flow's in_port.
  66      *
  67      *    - If NXAST_RESUBMIT is preceded by actions that affect the flow
  68      *      (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
  69      *      values.
  70      *
  71      * Following the lookup, the original in_port is restored.
  72      *
  73      * If the modified flow matched in the flow table, then the corresponding
  74      * actions are executed, except that NXAST_RESUBMIT actions found in the
  75      * secondary set of actions are ignored.  Afterward, actions following
  76      * NXAST_RESUBMIT in the original set of actions, if any, are executed; any
  77      * changes made to the packet (e.g. changes to VLAN) by secondary actions
  78      * persist when those actions are executed, although the original in_port
  79      * is restored.
  80      *
  81      * NXAST_RESUBMIT may be used any number of times within a set of actions.
  82      */
  83     NXAST_RESUBMIT
  84 };
  85
  86 /* Action structure for NXAST_RESUBMIT. */
  87 struct nx_action_resubmit {
  88     uint16_t type;                  /* OFPAT_VENDOR. */
  89     uint16_t len;                   /* Length is 8. */
  90     uint32_t vendor;                /* NX_VENDOR_ID. */
  91     uint16_t subtype;               /* NXAST_RESUBMIT. */
  92     uint16_t in_port;               /* New in_port for checking flow table. */
  93     uint8_t pad[4];
  94 };
  95 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
  96
  97 /* Header for Nicira-defined actions. */
  98 struct nx_action_header {
  99     uint16_t type;                  /* OFPAT_VENDOR. */
 100     uint16_t len;                   /* Length is 8. */
 101     uint32_t vendor;                /* NX_VENDOR_ID. */
 102     uint16_t subtype;               /* NXAST_*. */
 103     uint8_t pad[6];
 104 };
 105 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
 106
 107 #endif /* openflow/nicira-ext.h */