include/openvswitch/types.h

   1 /*
   2  * Copyright (c) 2010, 2011 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 OPENVSWITCH_TYPES_H
  18 #define OPENVSWITCH_TYPES_H 1
  19
  20 #include <sys/types.h>
  21 #include <stdint.h>
  22
  23 #ifdef __CHECKER__
  24 #define OVS_BITWISE __attribute__((bitwise))
  25 #define OVS_FORCE __attribute__((force))
  26 #else
  27 #define OVS_BITWISE
  28 #define OVS_FORCE
  29 #endif
  30
  31 /* The ovs_be<N> types indicate that an object is in big-endian, not
  32  * native-endian, byte order.  They are otherwise equivalent to uint<N>_t.
  33  *
  34  * The OVS_BITWISE annotation allows the sparse checker to issue warnings
  35  * for incorrect use of values in network byte order. */
  36 typedef uint16_t OVS_BITWISE ovs_be16;
  37 typedef uint32_t OVS_BITWISE ovs_be32;
  38 typedef uint64_t OVS_BITWISE ovs_be64;
  39 \f
  40 /* Netlink and OpenFlow both contain 64-bit values that are only guaranteed to
  41  * be aligned on 32-bit boundaries.  These types help.
  42  *
  43  * lib/unaligned.h has helper functions for accessing these. */
  44
  45 /* A 64-bit value, in host byte order, that is only aligned on a 32-bit
  46  * boundary.  */
  47 typedef struct {
  48 #ifdef WORDS_BIGENDIAN
  49         uint32_t hi, lo;
  50 #else
  51         uint32_t lo, hi;
  52 #endif
  53 } ovs_32aligned_u64;
  54
  55 /* A 64-bit value, in network byte order, that is only aligned on a 32-bit
  56  * boundary. */
  57 typedef struct {
  58         ovs_be32 hi, lo;
  59 } ovs_32aligned_be64;
  60
  61 #endif /* openvswitch/types.h */