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     /* Use the high 32 bits of the cookie field as the tunnel ID in the flow
  50      * match. */
  51     NXT_TUN_ID_FROM_COOKIE,
  52
  53     /* Controller role support.  The request body is struct nx_role_request.
  54      * The reply echos the request. */
  55     NXT_ROLE_REQUEST,
  56     NXT_ROLE_REPLY
  57 };
  58
  59 struct nicira_header {
  60     struct ofp_header header;
  61     uint32_t vendor;            /* NX_VENDOR_ID. */
  62     uint32_t subtype;           /* One of NXT_* above. */
  63 };
  64 OFP_ASSERT(sizeof(struct nicira_header) == 16);
  65
  66 struct nxt_tun_id_cookie {
  67     struct ofp_header header;
  68     uint32_t vendor;            /* NX_VENDOR_ID. */
  69     uint32_t subtype;           /* NXT_TUN_ID_FROM_COOKIE */
  70     uint8_t set;                /* Nonzero to enable, zero to disable. */
  71     uint8_t pad[7];
  72 };
  73 OFP_ASSERT(sizeof(struct nxt_tun_id_cookie) == 24);
  74
  75 /* Configures the "role" of the sending controller.  The default role is:
  76  *
  77  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
  78  *      OpenFlow features.
  79  *
  80  * The other possible roles are a related pair:
  81  *
  82  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
  83  *      be at most one Master controller at a time: when a controller
  84  *      configures itself as Master, any existing Master is demoted to the
  85  *      Slave role.
  86  *
  87  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
  88  *      OpenFlow features.  In particular attempts to modify the flow table
  89  *      will be rejected with an OFPBRC_EPERM error.
  90  *
  91  *      Slave controllers also do not receive asynchronous messages
  92  *      (OFPT_PACKET_IN, OFPT_FLOW_REMOVED, OFPT_PORT_STATUS).
  93  */
  94 struct nx_role_request {
  95     struct nicira_header nxh;
  96     uint32_t role;              /* One of NX_ROLE_*. */
  97 };
  98
  99 enum nx_role {
 100     NX_ROLE_OTHER,              /* Default role, full access. */
 101     NX_ROLE_MASTER,             /* Full access, at most one. */
 102     NX_ROLE_SLAVE               /* Read-only access. */
 103 };
 104
 105 enum nx_action_subtype {
 106     NXAST_SNAT__OBSOLETE,           /* No longer used. */
 107
 108     /* Searches the flow table again, using a flow that is slightly modified
 109      * from the original lookup:
 110      *
 111      *    - The 'in_port' member of struct nx_action_resubmit is used as the
 112      *      flow's in_port.
 113      *
 114      *    - If NXAST_RESUBMIT is preceded by actions that affect the flow
 115      *      (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
 116      *      values.
 117      *
 118      * Following the lookup, the original in_port is restored.
 119      *
 120      * If the modified flow matched in the flow table, then the corresponding
 121      * actions are executed.  Afterward, actions following NXAST_RESUBMIT in
 122      * the original set of actions, if any, are executed; any changes made to
 123      * the packet (e.g. changes to VLAN) by secondary actions persist when
 124      * those actions are executed, although the original in_port is restored.
 125      *
 126      * NXAST_RESUBMIT may be used any number of times within a set of actions.
 127      *
 128      * NXAST_RESUBMIT may nest to an implementation-defined depth.  Beyond this
 129      * implementation-defined depth, further NXAST_RESUBMIT actions are simply
 130      * ignored.  (Open vSwitch 1.0.1 and earlier did not support recursion.)
 131      */
 132     NXAST_RESUBMIT,
 133
 134     /* Set encapsulating tunnel ID. */
 135     NXAST_SET_TUNNEL,
 136
 137     /* Stops processing further actions, if the packet being processed is an
 138      * Ethernet+IPv4 ARP packet for which the source Ethernet address inside
 139      * the ARP packet differs from the source Ethernet address in the Ethernet
 140      * header.
 141      *
 142      * This is useful because OpenFlow does not provide a way to match on the
 143      * Ethernet addresses inside ARP packets, so there is no other way to drop
 144      * spoofed ARPs other than sending every packet up to the controller. */
 145     NXAST_DROP_SPOOFED_ARP
 146 };
 147
 148 /* Action structure for NXAST_RESUBMIT. */
 149 struct nx_action_resubmit {
 150     uint16_t type;                  /* OFPAT_VENDOR. */
 151     uint16_t len;                   /* Length is 16. */
 152     uint32_t vendor;                /* NX_VENDOR_ID. */
 153     uint16_t subtype;               /* NXAST_RESUBMIT. */
 154     uint16_t in_port;               /* New in_port for checking flow table. */
 155     uint8_t pad[4];
 156 };
 157 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
 158
 159 /* Action structure for NXAST_SET_TUNNEL. */
 160 struct nx_action_set_tunnel {
 161     uint16_t type;                  /* OFPAT_VENDOR. */
 162     uint16_t len;                   /* Length is 16. */
 163     uint32_t vendor;                /* NX_VENDOR_ID. */
 164     uint16_t subtype;               /* NXAST_SET_TUNNEL. */
 165     uint8_t pad[2];
 166     uint32_t tun_id;                /* Tunnel ID. */
 167 };
 168 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
 169
 170 /* Header for Nicira-defined actions. */
 171 struct nx_action_header {
 172     uint16_t type;                  /* OFPAT_VENDOR. */
 173     uint16_t len;                   /* Length is 16. */
 174     uint32_t vendor;                /* NX_VENDOR_ID. */
 175     uint16_t subtype;               /* NXAST_*. */
 176     uint8_t pad[6];
 177 };
 178 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
 179
 180 /* Wildcard for tunnel ID. */
 181 #define NXFW_TUN_ID  (1 << 25)
 182
 183 #define NXFW_ALL NXFW_TUN_ID
 184 #define OVSFW_ALL (OFPFW_ALL | NXFW_ALL)
 185
 186 #endif /* openflow/nicira-ext.h */