include/openvswitch/types.h

   1 /*
   2  * Copyright (c) 2010, 2011, 2013, 2014 Nicira, Inc.
   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 OPENVSWITCH_TYPES_H
  18 #define OPENVSWITCH_TYPES_H 1
  19
  20 #include <sys/types.h>
  21 #include <stdint.h>
  22 #include "openvswitch/compiler.h"
  23
  24 #ifdef __CHECKER__
  25 #define OVS_BITWISE __attribute__((bitwise))
  26 #define OVS_FORCE __attribute__((force))
  27 #else
  28 #define OVS_BITWISE
  29 #define OVS_FORCE
  30 #endif
  31
  32 /* The ovs_be<N> types indicate that an object is in big-endian, not
  33  * native-endian, byte order.  They are otherwise equivalent to uint<N>_t. */
  34 typedef uint16_t OVS_BITWISE ovs_be16;
  35 typedef uint32_t OVS_BITWISE ovs_be32;
  36 typedef uint64_t OVS_BITWISE ovs_be64;
  37
  38 #define OVS_BE16_MAX ((OVS_FORCE ovs_be16) 0xffff)
  39 #define OVS_BE32_MAX ((OVS_FORCE ovs_be32) 0xffffffff)
  40 #define OVS_BE64_MAX ((OVS_FORCE ovs_be64) 0xffffffffffffffffULL)
  41 \f
  42 /* These types help with a few funny situations:
  43  *
  44  *   - The Ethernet header is 14 bytes long, which misaligns everything after
  45  *     that.  One can put 2 "shim" bytes before the Ethernet header, but this
  46  *     helps only if there is exactly one Ethernet header.  If there are two,
  47  *     as with GRE and VXLAN (and if the inner header doesn't use this
  48  *     trick--GRE and VXLAN don't) then you have the choice of aligning the
  49  *     inner data or the outer data.  So it seems better to treat 32-bit fields
  50  *     in protocol headers as aligned only on 16-bit boundaries.
  51  *
  52  *   - ARP headers contain misaligned 32-bit fields.
  53  *
  54  *   - Netlink and OpenFlow contain 64-bit values that are only guaranteed to
  55  *     be aligned on 32-bit boundaries.
  56  *
  57  * lib/unaligned.h has helper functions for accessing these. */
  58
  59 /* A 32-bit value, in host byte order, that is only aligned on a 16-bit
  60  * boundary.  */
  61 typedef struct {
  62 #ifdef WORDS_BIGENDIAN
  63         uint16_t hi, lo;
  64 #else
  65         uint16_t lo, hi;
  66 #endif
  67 } ovs_16aligned_u32;
  68
  69 /* A 32-bit value, in network byte order, that is only aligned on a 16-bit
  70  * boundary. */
  71 typedef struct {
  72         ovs_be16 hi, lo;
  73 } ovs_16aligned_be32;
  74
  75 /* A 64-bit value, in host byte order, that is only aligned on a 32-bit
  76  * boundary.  */
  77 typedef struct {
  78 #ifdef WORDS_BIGENDIAN
  79         uint32_t hi, lo;
  80 #else
  81         uint32_t lo, hi;
  82 #endif
  83 } ovs_32aligned_u64;
  84
  85 typedef union {
  86     uint32_t u32[4];
  87     struct {
  88 #ifdef WORDS_BIGENDIAN
  89         uint64_t hi, lo;
  90 #else
  91         uint64_t lo, hi;
  92 #endif
  93     } u64;
  94 } ovs_u128;
  95
  96 typedef union {
  97     ovs_be32 be32[4];
  98     struct {
  99         ovs_be64 hi, lo;
 100     } be64;
 101 } ovs_be128;
 102
 103 /* MSVC2015 doesn't support designated initializers when compiling C++,
 104  * and doesn't support ternary operators with non-designated initializers.
 105  * So we use these static definitions rather than using initializer macros. */
 106 static const ovs_u128 OVS_U128_MAX = { { UINT32_MAX, UINT32_MAX,
 107                                          UINT32_MAX, UINT32_MAX } };
 108 static const ovs_be128 OVS_BE128_MAX OVS_UNUSED = { { OVS_BE32_MAX, OVS_BE32_MAX,
 109                                            OVS_BE32_MAX, OVS_BE32_MAX } };
 110
 111 /* A 64-bit value, in network byte order, that is only aligned on a 32-bit
 112  * boundary. */
 113 typedef struct {
 114         ovs_be32 hi, lo;
 115 } ovs_32aligned_be64;
 116
 117 /* ofp_port_t represents the port number of a OpenFlow switch.
 118  * odp_port_t represents the port number on the datapath.
 119  * ofp11_port_t represents the OpenFlow-1.1 port number. */
 120 typedef uint16_t OVS_BITWISE ofp_port_t;
 121 typedef uint32_t OVS_BITWISE odp_port_t;
 122 typedef uint32_t OVS_BITWISE ofp11_port_t;
 123
 124 /* Macro functions that cast int types to ofp/odp/ofp11 types. */
 125 #define OFP_PORT_C(X) ((OVS_FORCE ofp_port_t) (X))
 126 #define ODP_PORT_C(X) ((OVS_FORCE odp_port_t) (X))
 127 #define OFP11_PORT_C(X) ((OVS_FORCE ofp11_port_t) (X))
 128
 129 /* Using this struct instead of a bare array makes an ethernet address field
 130  * assignable.  The size of the array is also part of the type, so it is easier
 131  * to deal with. */
 132 struct eth_addr {
 133     union {
 134         uint8_t ea[6];
 135         ovs_be16 be16[3];
 136     };
 137 };
 138
 139 #endif /* openvswitch/types.h */