2 * Copyright (c) 2010, 2011, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef OPENVSWITCH_TYPES_H
18 #define OPENVSWITCH_TYPES_H 1
20 #include <linux/types.h>
21 #include <sys/types.h>
25 #define OVS_BITWISE __attribute__((bitwise))
26 #define OVS_FORCE __attribute__((force))
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.
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
38 typedef __be16 ovs_be16;
39 typedef __be32 ovs_be32;
40 typedef __be64 ovs_be64;
42 #define OVS_BE16_MAX ((OVS_FORCE ovs_be16) 0xffff)
43 #define OVS_BE32_MAX ((OVS_FORCE ovs_be32) 0xffffffff)
44 #define OVS_BE64_MAX ((OVS_FORCE ovs_be64) 0xffffffffffffffffULL)
46 /* These types help with a few funny situations:
48 * - The Ethernet header is 14 bytes long, which misaligns everything after
49 * that. One can put 2 "shim" bytes before the Ethernet header, but this
50 * helps only if there is exactly one Ethernet header. If there are two,
51 * as with GRE and VXLAN (and if the inner header doesn't use this
52 * trick--GRE and VXLAN don't) then you have the choice of aligning the
53 * inner data or the outer data. So it seems better to treat 32-bit fields
54 * in protocol headers as aligned only on 16-bit boundaries.
56 * - ARP headers contain misaligned 32-bit fields.
58 * - Netlink and OpenFlow contain 64-bit values that are only guaranteed to
59 * be aligned on 32-bit boundaries.
61 * lib/unaligned.h has helper functions for accessing these. */
63 /* A 32-bit value, in host byte order, that is only aligned on a 16-bit
66 #ifdef WORDS_BIGENDIAN
73 /* A 32-bit value, in network byte order, that is only aligned on a 16-bit
79 /* A 64-bit value, in host byte order, that is only aligned on a 32-bit
82 #ifdef WORDS_BIGENDIAN
89 /* A 64-bit value, in network byte order, that is only aligned on a 32-bit
95 /* ofp_port_t represents the port number of a OpenFlow switch.
96 * odp_port_t represents the port number on the datapath.
97 * ofp11_port_t represents the OpenFlow-1.1 port number. */
98 typedef uint16_t OVS_BITWISE ofp_port_t;
99 typedef uint32_t OVS_BITWISE odp_port_t;
100 typedef uint32_t OVS_BITWISE ofp11_port_t;
102 /* Macro functions that cast int types to ofp/odp/ofp11 types. */
103 #define OFP_PORT_C(X) ((OVS_FORCE ofp_port_t) (X))
104 #define ODP_PORT_C(X) ((OVS_FORCE odp_port_t) (X))
105 #define OFP11_PORT_C(X) ((OVS_FORCE ofp11_port_t) (X))
107 #endif /* openvswitch/types.h */