lib/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 "compiler.h"
  39 #include "random.h"
  40 #include "util.h"
  41
  42 #define ETH_ADDR_LEN           6
  43
  44 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] UNUSED
  45     = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
  46
  47 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
  48 {
  49     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
  50 }
  51 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
  52 {
  53     return ea[0] & 1;
  54 }
  55 static inline bool eth_addr_is_local(const uint8_t ea[6])
  56 {
  57     return ea[0] & 2;
  58 }
  59 static inline bool eth_addr_is_zero(const uint8_t ea[6])
  60 {
  61     return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
  62 }
  63 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
  64                                    const uint8_t b[ETH_ADDR_LEN])
  65 {
  66     return !memcmp(a, b, ETH_ADDR_LEN);
  67 }
  68 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
  69 {
  70     return (((uint64_t) ea[0] << 40)
  71             | ((uint64_t) ea[1] << 32)
  72             | ((uint64_t) ea[2] << 24)
  73             | ((uint64_t) ea[3] << 16)
  74             | ((uint64_t) ea[4] << 8)
  75             | ea[5]);
  76 }
  77 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
  78 {
  79     ea[0] = x >> 40;
  80     ea[1] = x >> 32;
  81     ea[2] = x >> 24;
  82     ea[3] = x >> 16;
  83     ea[4] = x >> 8;
  84     ea[5] = x;
  85 }
  86 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
  87 {
  88     random_bytes(ea, ETH_ADDR_LEN);
  89     ea[0] &= ~1;                /* Unicast. */
  90     ea[0] |= 2;                 /* Private. */
  91 }
  92
  93 #define ETH_ADDR_FMT                                                    \
  94     "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
  95 #define ETH_ADDR_ARGS(ea)                                   \
  96     (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
  97
  98 #define ETH_TYPE_IP            0x0800
  99 #define ETH_TYPE_ARP           0x0806
 100 #define ETH_TYPE_VLAN          0x8100
 101
 102 #define ETH_HEADER_LEN 14
 103 #define ETH_PAYLOAD_MIN 46
 104 #define ETH_PAYLOAD_MAX 1500
 105 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
 106 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
 107 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
 108 struct eth_header {
 109     uint8_t eth_dst[ETH_ADDR_LEN];
 110     uint8_t eth_src[ETH_ADDR_LEN];
 111     uint16_t eth_type;
 112 } __attribute__((packed));
 113 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
 114
 115 #define LLC_DSAP_SNAP 0xaa
 116 #define LLC_SSAP_SNAP 0xaa
 117 #define LLC_CNTL_SNAP 3
 118
 119 #define LLC_HEADER_LEN 3
 120 struct llc_header {
 121     uint8_t llc_dsap;
 122     uint8_t llc_ssap;
 123     uint8_t llc_cntl;
 124 } __attribute__((packed));
 125 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
 126
 127 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
 128                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
 129 #define SNAP_HEADER_LEN 5
 130 struct snap_header {
 131     uint8_t snap_org[3];
 132     uint16_t snap_type;
 133 } __attribute__((packed));
 134 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
 135
 136 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
 137 struct llc_snap_header {
 138     struct llc_header llc;
 139     struct snap_header snap;
 140 } __attribute__((packed));
 141 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
 142
 143 #define VLAN_VID_MASK 0x0fff
 144 #define VLAN_PCP_MASK 0xe000
 145
 146 #define VLAN_HEADER_LEN 4
 147 struct vlan_header {
 148     uint16_t vlan_tci;          /* Lowest 12 bits are VLAN ID. */
 149     uint16_t vlan_next_type;
 150 };
 151 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
 152
 153 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
 154 struct vlan_eth_header {
 155     uint8_t veth_dst[ETH_ADDR_LEN];
 156     uint8_t veth_src[ETH_ADDR_LEN];
 157     uint16_t veth_type;         /* Always htons(ETH_TYPE_VLAN). */
 158     uint16_t veth_tci;          /* Lowest 12 bits are VLAN ID. */
 159     uint16_t veth_next_type;
 160 } __attribute__((packed));
 161 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
 162
 163 /* The "(void) (ip)[0]" below has no effect on the value, since it's the first
 164  * argument of a comma expression, but it makes sure that 'ip' is a pointer.
 165  * This is useful since a common mistake is to pass an integer instead of a
 166  * pointer to IP_ARGS. */
 167 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
 168 #define IP_ARGS(ip)                             \
 169         ((void) (ip)[0], ((uint8_t *) ip)[0]),  \
 170         ((uint8_t *) ip)[1],                    \
 171         ((uint8_t *) ip)[2],                    \
 172         ((uint8_t *) ip)[3]
 173
 174 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
 175 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
 176 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
 177
 178 #define IP_TYPE_ICMP 1
 179 #define IP_TYPE_TCP 6
 180 #define IP_TYPE_UDP 17
 181
 182 #define IP_VERSION 4
 183
 184 #define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
 185 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
 186 #define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
 187 #define IP_IS_FRAGMENT(ip_frag_off) \
 188         ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
 189
 190 #define IP_HEADER_LEN 20
 191 struct ip_header {
 192     uint8_t ip_ihl_ver;
 193     uint8_t ip_tos;
 194     uint16_t ip_tot_len;
 195     uint16_t ip_id;
 196     uint16_t ip_frag_off;
 197     uint8_t ip_ttl;
 198     uint8_t ip_proto;
 199     uint16_t ip_csum;
 200     uint32_t ip_src;
 201     uint32_t ip_dst;
 202 };
 203 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
 204
 205 #define UDP_HEADER_LEN 8
 206 struct udp_header {
 207     uint16_t udp_src;
 208     uint16_t udp_dst;
 209     uint16_t udp_len;
 210     uint16_t udp_csum;
 211 };
 212 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
 213
 214 #define TCP_FIN 0x01
 215 #define TCP_SYN 0x02
 216 #define TCP_RST 0x04
 217 #define TCP_PSH 0x08
 218 #define TCP_ACK 0x10
 219 #define TCP_URG 0x20
 220
 221 #define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
 222 #define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)
 223
 224 #define TCP_HEADER_LEN 20
 225 struct tcp_header {
 226     uint16_t tcp_src;
 227     uint16_t tcp_dst;
 228     uint32_t tcp_seq;
 229     uint32_t tcp_ack;
 230     uint16_t tcp_ctl;
 231     uint16_t tcp_winsz;
 232     uint16_t tcp_csum;
 233     uint16_t tcp_urg;
 234 };
 235 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
 236
 237 #define ARP_HRD_ETHERNET 1
 238 #define ARP_PRO_IP 0x0800
 239 #define ARP_OP_REQUEST 1
 240 #define ARP_OP_REPLY 2
 241
 242 #define ARP_ETH_HEADER_LEN 28
 243 struct arp_eth_header {
 244     /* Generic members. */
 245     uint16_t ar_hrd;           /* Hardware type. */
 246     uint16_t ar_pro;           /* Protocol type. */
 247     uint8_t ar_hln;            /* Hardware address length. */
 248     uint8_t ar_pln;            /* Protocol address length. */
 249     uint16_t ar_op;            /* Opcode. */
 250
 251     /* Ethernet+IPv4 specific members. */
 252     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
 253     uint32_t ar_spa;           /* Sender protocol address. */
 254     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
 255     uint32_t ar_tpa;           /* Target protocol address. */
 256 } __attribute__((packed));
 257 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
 258
 259 #endif /* packets.h */