pintos-os.org Git - openvswitch/blob - include/packets.h

   1 /* Copyright (c) 2008 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 #ifndef PACKETS_H
  34 #define PACKETS_H 1
  35
  36 #include <stdint.h>
  37 #include <string.h>
  38 #include "util.h"
  39
  40 #define ETH_ADDR_LEN           6
  41
  42 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
  43 {
  44     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
  45 }
  46 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
  47 {
  48     return ea[0] & 1;
  49 }
  50 static inline bool eth_addr_is_local(const uint8_t ea[6])
  51 {
  52     return ea[0] & 2;
  53 }
  54 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
  55                                    const uint8_t b[ETH_ADDR_LEN])
  56 {
  57     return !memcmp(a, b, ETH_ADDR_LEN);
  58 }
  59 #define ETH_ADDR_FMT                                                    \
  60     "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
  61 #define ETH_ADDR_ARGS(ea)                                   \
  62     (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
  63
  64 #define ETH_TYPE_IP            0x0800
  65 #define ETH_TYPE_ARP           0x0806
  66 #define ETH_TYPE_VLAN          0x8100
  67
  68 #define ETH_HEADER_LEN 14
  69 #define ETH_PAYLOAD_MIN 46
  70 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
  71 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + 1500)
  72 struct eth_header {
  73     uint8_t eth_dst[ETH_ADDR_LEN];
  74     uint8_t eth_src[ETH_ADDR_LEN];
  75     uint16_t eth_type;
  76 } __attribute__((packed));
  77 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
  78
  79 #define LLC_DSAP_SNAP 0xaa
  80 #define LLC_SSAP_SNAP 0xaa
  81 #define LLC_CNTL_SNAP 3
  82
  83 #define LLC_HEADER_LEN 3
  84 struct llc_header {
  85     uint8_t llc_dsap;
  86     uint8_t llc_ssap;
  87     uint8_t llc_cntl;
  88 } __attribute__((packed));
  89 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
  90
  91 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
  92                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
  93 #define SNAP_HEADER_LEN 5
  94 struct snap_header {
  95     uint8_t snap_org[3];
  96     uint16_t snap_type;
  97 } __attribute__((packed));
  98 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
  99
 100 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
 101 struct llc_snap_header {
 102     struct llc_header llc;
 103     struct snap_header snap;
 104 } __attribute__((packed));
 105 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
 106
 107 #define VLAN_VID 0x0fff
 108
 109 #define VLAN_HEADER_LEN 4
 110 struct vlan_header {
 111     uint16_t vlan_tci;          /* Lowest 12 bits are VLAN ID. */
 112     uint16_t vlan_next_type;
 113 };
 114 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
 115
 116 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
 117 struct vlan_eth_header {
 118     uint8_t veth_dst[ETH_ADDR_LEN];
 119     uint8_t veth_src[ETH_ADDR_LEN];
 120     uint16_t veth_type;         /* Always htons(ETH_TYPE_VLAN). */
 121     uint16_t veth_tci;          /* Lowest 12 bits are VLAN ID. */
 122     uint16_t veth_next_type;
 123 } __attribute__((packed));
 124 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
 125
 126 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
 127 #define IP_ARGS(ip)                             \
 128         ((uint8_t *) ip)[0],                    \
 129         ((uint8_t *) ip)[1],                    \
 130         ((uint8_t *) ip)[2],                    \
 131         ((uint8_t *) ip)[3]
 132
 133 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
 134 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
 135
 136 #define IP_TYPE_TCP 6
 137 #define IP_TYPE_UDP 17
 138
 139 #define IP_HEADER_LEN 20
 140 struct ip_header {
 141     uint8_t ip_ihl_ver;
 142     uint8_t ip_tos;
 143     uint16_t ip_tot_len;
 144     uint16_t ip_id;
 145     uint16_t ip_frag_off;
 146     uint8_t ip_ttl;
 147     uint8_t ip_proto;
 148     uint16_t ip_csum;
 149     uint32_t ip_src;
 150     uint32_t ip_dst;
 151 };
 152 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
 153
 154 #define UDP_HEADER_LEN 8
 155 struct udp_header {
 156     uint16_t udp_src;
 157     uint16_t udp_dst;
 158     uint16_t udp_len;
 159     uint16_t udp_csum;
 160 };
 161 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
 162
 163 #define TCP_FIN 0x01
 164 #define TCP_SYN 0x02
 165 #define TCP_RST 0x04
 166 #define TCP_PSH 0x08
 167 #define TCP_ACK 0x10
 168 #define TCP_URG 0x20
 169
 170 #define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
 171 #define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)
 172
 173 #define TCP_HEADER_LEN 20
 174 struct tcp_header {
 175     uint16_t tcp_src;
 176     uint16_t tcp_dst;
 177     uint32_t tcp_seq;
 178     uint32_t tcp_ack;
 179     uint16_t tcp_ctl;
 180     uint16_t tcp_winsz;
 181     uint16_t tcp_csum;
 182     uint16_t tcp_urg;
 183 };
 184 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
 185
 186 #define ARP_HRD_ETHERNET 1
 187 #define ARP_PRO_IP 0x0800
 188 #define ARP_OP_REQUEST 1
 189 #define ARP_OP_REPLY 2
 190
 191 #define ARP_ETH_HEADER_LEN 28
 192 struct arp_eth_header {
 193     /* Generic members. */
 194     uint16_t ar_hrd;           /* Hardware type. */
 195     uint16_t ar_pro;           /* Protocol type. */
 196     uint8_t ar_hln;            /* Hardware address length. */
 197     uint8_t ar_pln;            /* Protocol address length. */
 198     uint16_t ar_op;            /* Opcode. */
 199
 200     /* Ethernet+IPv4 specific members. */
 201     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
 202     uint32_t ar_spa;           /* Sender protocol address. */
 203     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
 204     uint32_t ar_tpa;           /* Target protocol address. */
 205 } __attribute__((packed));
 206 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
 207
 208 #endif /* packets.h */