pintos-os.org Git - openvswitch/blob - include/openflow/openflow-common.h

   1 /* Copyright (c) 2008, 2011 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 /*
  35  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
  36  *
  37  * Licensed under the Apache License, Version 2.0 (the "License");
  38  * you may not use this file except in compliance with the License.
  39  * You may obtain a copy of the License at:
  40  *
  41  *     http://www.apache.org/licenses/LICENSE-2.0
  42  *
  43  * Unless required by applicable law or agreed to in writing, software
  44  * distributed under the License is distributed on an "AS IS" BASIS,
  45  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  46  * See the License for the specific language governing permissions and
  47  * limitations under the License.
  48  */
  49
  50 #ifndef OPENFLOW_COMMON_H
  51 #define OPENFLOW_COMMON_H 1
  52
  53 #include "openvswitch/types.h"
  54
  55 #ifdef SWIG
  56 #define OFP_ASSERT(EXPR)        /* SWIG can't handle OFP_ASSERT. */
  57 #elif !defined(__cplusplus)
  58 /* Build-time assertion for use in a declaration context. */
  59 #define OFP_ASSERT(EXPR)                                                \
  60         extern int (*build_assert(void))[ sizeof(struct {               \
  61                     unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
  62 #else /* __cplusplus */
  63 #include <boost/static_assert.hpp>
  64 #define OFP_ASSERT BOOST_STATIC_ASSERT
  65 #endif /* __cplusplus */
  66
  67 /* Version number:
  68  * Non-experimental versions released: 0x01 0x02
  69  * Experimental versions released: 0x81 -- 0x99
  70  */
  71 /* The most significant bit being set in the version field indicates an
  72  * experimental OpenFlow version.
  73  */
  74 #define OFP10_VERSION   0x01
  75 #define OFP11_VERSION   0x02
  76
  77 #define OFP_MAX_TABLE_NAME_LEN 32
  78 #define OFP_MAX_PORT_NAME_LEN  16
  79
  80 #define OFP_TCP_PORT  6633
  81 #define OFP_SSL_PORT  6633
  82
  83 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
  84
  85 /* Common OpenFlow message types. */
  86 enum ofp_type {
  87     /* Immutable messages. */
  88     OFPT_HELLO,               /* Symmetric message */
  89     OFPT_ERROR,               /* Symmetric message */
  90     OFPT_ECHO_REQUEST,        /* Symmetric message */
  91     OFPT_ECHO_REPLY,          /* Symmetric message */
  92     OFPT_VENDOR,              /* Symmetric message */
  93
  94     /* Switch configuration messages. */
  95     OFPT_FEATURES_REQUEST,    /* Controller/switch message */
  96     OFPT_FEATURES_REPLY,      /* Controller/switch message */
  97     OFPT_GET_CONFIG_REQUEST,  /* Controller/switch message */
  98     OFPT_GET_CONFIG_REPLY,    /* Controller/switch message */
  99     OFPT_SET_CONFIG,          /* Controller/switch message */
 100
 101     /* Asynchronous messages. */
 102     OFPT_PACKET_IN,           /* Async message */
 103     OFPT_FLOW_REMOVED,        /* Async message */
 104     OFPT_PORT_STATUS,         /* Async message */
 105 };
 106
 107 #endif /* openflow/openflow-common.h */