include/openvswitch/types.h

   1 /*
   2  * Copyright (c) 2010, 2011 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 <linux/types.h>
  21 #include <sys/types.h>
  22 #include <stdint.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  *
  35  * We bootstrap these from the Linux __be<N> types.  If we instead define our
  36  * own independently then __be<N> and ovs_be<N> become mutually
  37  * incompatible. */
  38 typedef __be16 ovs_be16;
  39 typedef __be32 ovs_be32;
  40 typedef __be64 ovs_be64;
  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 /* A 64-bit value, in network byte order, that is only aligned on a 32-bit
  86  * boundary. */
  87 typedef struct {
  88         ovs_be32 hi, lo;
  89 } ovs_32aligned_be64;
  90
  91 #endif /* openvswitch/types.h */