lib/packets.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 PACKETS_H
  18 #define PACKETS_H 1
  19
  20 #include <inttypes.h>
  21 #include <sys/types.h>
  22 #include <netinet/in.h>
  23 #include <stdint.h>
  24 #include <string.h>
  25 #include "compiler.h"
  26 #include "openvswitch/types.h"
  27 #include "random.h"
  28 #include "hash.h"
  29 #include "tun-metadata.h"
  30 #include "util.h"
  31
  32 struct dp_packet;
  33 struct ds;
  34
  35 /* Tunnel information used in flow key and metadata. */
  36 struct flow_tnl {
  37     ovs_be64 tun_id;
  38     ovs_be32 ip_dst;
  39     ovs_be32 ip_src;
  40     uint16_t flags;
  41     uint8_t ip_tos;
  42     uint8_t ip_ttl;
  43     ovs_be16 tp_src;
  44     ovs_be16 tp_dst;
  45     ovs_be16 gbp_id;
  46     uint8_t  gbp_flags;
  47     uint8_t  pad1[5];        /* Pad to 64 bits. */
  48     struct tun_metadata metadata;
  49 };
  50
  51 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
  52  * numbers and other times datapath (dpif) port numbers.  This union allows
  53  * access to both. */
  54 union flow_in_port {
  55     odp_port_t odp_port;
  56     ofp_port_t ofp_port;
  57 };
  58
  59 /* Datapath packet metadata */
  60 struct pkt_metadata {
  61     uint32_t recirc_id;         /* Recirculation id carried with the
  62                                    recirculating packets. 0 for packets
  63                                    received from the wire. */
  64     uint32_t dp_hash;           /* hash value computed by the recirculation
  65                                    action. */
  66     uint32_t skb_priority;      /* Packet priority for QoS. */
  67     uint32_t pkt_mark;          /* Packet mark. */
  68     union flow_in_port in_port; /* Input port. */
  69     struct flow_tnl tunnel;     /* Encapsulating tunnel parameters. */
  70 };
  71
  72 static inline void
  73 pkt_metadata_init(struct pkt_metadata *md, odp_port_t port)
  74 {
  75     /* It can be expensive to zero out all of the tunnel metadata. However,
  76      * we can just zero out ip_dst and the rest of the data will never be
  77      * looked at. */
  78     memset(md, 0, offsetof(struct pkt_metadata, tunnel));
  79     md->tunnel.ip_dst = 0;
  80
  81     md->in_port.odp_port = port;
  82 }
  83
  84 bool dpid_from_string(const char *s, uint64_t *dpidp);
  85
  86 #define ETH_ADDR_LEN           6
  87
  88 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
  89     = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
  90
  91 static const uint8_t eth_addr_zero[ETH_ADDR_LEN] OVS_UNUSED
  92     = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
  93
  94 static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
  95     = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 };
  96
  97 static const uint8_t eth_addr_lacp[ETH_ADDR_LEN] OVS_UNUSED
  98     = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 };
  99
 100 static const uint8_t eth_addr_bfd[ETH_ADDR_LEN] OVS_UNUSED
 101     = { 0x00, 0x23, 0x20, 0x00, 0x00, 0x01 };
 102
 103 static inline bool eth_addr_is_broadcast(const uint8_t ea[ETH_ADDR_LEN])
 104 {
 105     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
 106 }
 107
 108 static inline bool eth_addr_is_multicast(const uint8_t ea[ETH_ADDR_LEN])
 109 {
 110     return ea[0] & 1;
 111 }
 112 static inline bool eth_addr_is_local(const uint8_t ea[ETH_ADDR_LEN])
 113 {
 114     /* Local if it is either a locally administered address or a Nicira random
 115      * address. */
 116     return ea[0] & 2
 117        || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && ea[3] & 0x80);
 118 }
 119 static inline bool eth_addr_is_zero(const uint8_t ea[ETH_ADDR_LEN])
 120 {
 121     return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
 122 }
 123
 124 static inline int eth_mask_is_exact(const uint8_t ea[ETH_ADDR_LEN])
 125 {
 126     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
 127 }
 128
 129 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
 130                                         const uint8_t b[ETH_ADDR_LEN])
 131 {
 132     return memcmp(a, b, ETH_ADDR_LEN);
 133 }
 134 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
 135                                    const uint8_t b[ETH_ADDR_LEN])
 136 {
 137     return !eth_addr_compare_3way(a, b);
 138 }
 139 static inline bool eth_addr_equal_except(const uint8_t a[ETH_ADDR_LEN],
 140                                     const uint8_t b[ETH_ADDR_LEN],
 141                                     const uint8_t mask[ETH_ADDR_LEN])
 142 {
 143     return !(((a[0] ^ b[0]) & mask[0])
 144              || ((a[1] ^ b[1]) & mask[1])
 145              || ((a[2] ^ b[2]) & mask[2])
 146              || ((a[3] ^ b[3]) & mask[3])
 147              || ((a[4] ^ b[4]) & mask[4])
 148              || ((a[5] ^ b[5]) & mask[5]));
 149 }
 150 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
 151 {
 152     return (((uint64_t) ea[0] << 40)
 153             | ((uint64_t) ea[1] << 32)
 154             | ((uint64_t) ea[2] << 24)
 155             | ((uint64_t) ea[3] << 16)
 156             | ((uint64_t) ea[4] << 8)
 157             | ea[5]);
 158 }
 159 static inline uint64_t eth_addr_vlan_to_uint64(const uint8_t ea[ETH_ADDR_LEN],
 160                                                uint16_t vlan)
 161 {
 162     return (((uint64_t)vlan << 48) | eth_addr_to_uint64(ea));
 163 }
 164 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
 165 {
 166     ea[0] = x >> 40;
 167     ea[1] = x >> 32;
 168     ea[2] = x >> 24;
 169     ea[3] = x >> 16;
 170     ea[4] = x >> 8;
 171     ea[5] = x;
 172 }
 173 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
 174 {
 175     ea[0] &= ~1;                /* Unicast. */
 176     ea[0] |= 2;                 /* Private. */
 177 }
 178 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
 179 {
 180     random_bytes(ea, ETH_ADDR_LEN);
 181     eth_addr_mark_random(ea);
 182 }
 183 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
 184 {
 185     eth_addr_random(ea);
 186
 187     /* Set the OUI to the Nicira one. */
 188     ea[0] = 0x00;
 189     ea[1] = 0x23;
 190     ea[2] = 0x20;
 191
 192     /* Set the top bit to indicate random Nicira address. */
 193     ea[3] |= 0x80;
 194 }
 195 static inline uint32_t hash_mac(const uint8_t ea[ETH_ADDR_LEN],
 196                                 const uint16_t vlan, const uint32_t basis)
 197 {
 198     return hash_uint64_basis(eth_addr_vlan_to_uint64(ea, vlan), basis);
 199 }
 200
 201 bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN]);
 202 bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
 203
 204 void compose_rarp(struct dp_packet *, const uint8_t eth_src[ETH_ADDR_LEN]);
 205
 206 void eth_push_vlan(struct dp_packet *, ovs_be16 tpid, ovs_be16 tci);
 207 void eth_pop_vlan(struct dp_packet *);
 208
 209 const char *eth_from_hex(const char *hex, struct dp_packet **packetp);
 210 void eth_format_masked(const uint8_t eth[ETH_ADDR_LEN],
 211                        const uint8_t mask[ETH_ADDR_LEN], struct ds *s);
 212 void eth_addr_bitand(const uint8_t src[ETH_ADDR_LEN],
 213                      const uint8_t mask[ETH_ADDR_LEN],
 214                      uint8_t dst[ETH_ADDR_LEN]);
 215
 216 void set_mpls_lse(struct dp_packet *, ovs_be32 label);
 217 void push_mpls(struct dp_packet *packet, ovs_be16 ethtype, ovs_be32 lse);
 218 void pop_mpls(struct dp_packet *, ovs_be16 ethtype);
 219
 220 void set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl);
 221 void set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc);
 222 void set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label);
 223 void set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos);
 224 ovs_be32 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos,
 225                              ovs_be32 label);
 226
 227 /* Example:
 228  *
 229  * uint8_t mac[ETH_ADDR_LEN];
 230  *    [...]
 231  * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
 232  *
 233  */
 234 #define ETH_ADDR_FMT                                                    \
 235     "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
 236 #define ETH_ADDR_ARGS(ea)                                   \
 237     (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
 238
 239 /* Example:
 240  *
 241  * char *string = "1 00:11:22:33:44:55 2";
 242  * uint8_t mac[ETH_ADDR_LEN];
 243  * int a, b;
 244  *
 245  * if (ovs_scan(string, "%d"ETH_ADDR_SCAN_FMT"%d",
 246  *              &a, ETH_ADDR_SCAN_ARGS(mac), &b)) {
 247  *     ...
 248  * }
 249  */
 250 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
 251 #define ETH_ADDR_SCAN_ARGS(ea) \
 252         &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
 253
 254 #define ETH_TYPE_IP            0x0800
 255 #define ETH_TYPE_ARP           0x0806
 256 #define ETH_TYPE_TEB           0x6558
 257 #define ETH_TYPE_VLAN_8021Q    0x8100
 258 #define ETH_TYPE_VLAN          ETH_TYPE_VLAN_8021Q
 259 #define ETH_TYPE_VLAN_8021AD   0x88a8
 260 #define ETH_TYPE_IPV6          0x86dd
 261 #define ETH_TYPE_LACP          0x8809
 262 #define ETH_TYPE_RARP          0x8035
 263 #define ETH_TYPE_MPLS          0x8847
 264 #define ETH_TYPE_MPLS_MCAST    0x8848
 265
 266 static inline bool eth_type_mpls(ovs_be16 eth_type)
 267 {
 268     return eth_type == htons(ETH_TYPE_MPLS) ||
 269         eth_type == htons(ETH_TYPE_MPLS_MCAST);
 270 }
 271
 272 static inline bool eth_type_vlan(ovs_be16 eth_type)
 273 {
 274     return eth_type == htons(ETH_TYPE_VLAN_8021Q) ||
 275         eth_type == htons(ETH_TYPE_VLAN_8021AD);
 276 }
 277
 278
 279 /* Minimum value for an Ethernet type.  Values below this are IEEE 802.2 frame
 280  * lengths. */
 281 #define ETH_TYPE_MIN           0x600
 282
 283 #define ETH_HEADER_LEN 14
 284 #define ETH_PAYLOAD_MIN 46
 285 #define ETH_PAYLOAD_MAX 1500
 286 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
 287 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
 288 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
 289 OVS_PACKED(
 290 struct eth_header {
 291     uint8_t eth_dst[ETH_ADDR_LEN];
 292     uint8_t eth_src[ETH_ADDR_LEN];
 293     ovs_be16 eth_type;
 294 });
 295 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
 296
 297 #define LLC_DSAP_SNAP 0xaa
 298 #define LLC_SSAP_SNAP 0xaa
 299 #define LLC_CNTL_SNAP 3
 300
 301 #define LLC_HEADER_LEN 3
 302 OVS_PACKED(
 303 struct llc_header {
 304     uint8_t llc_dsap;
 305     uint8_t llc_ssap;
 306     uint8_t llc_cntl;
 307 });
 308 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
 309
 310 /* LLC field values used for STP frames. */
 311 #define STP_LLC_SSAP 0x42
 312 #define STP_LLC_DSAP 0x42
 313 #define STP_LLC_CNTL 0x03
 314
 315 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
 316                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
 317 #define SNAP_HEADER_LEN 5
 318 OVS_PACKED(
 319 struct snap_header {
 320     uint8_t snap_org[3];
 321     ovs_be16 snap_type;
 322 });
 323 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
 324
 325 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
 326 OVS_PACKED(
 327 struct llc_snap_header {
 328     struct llc_header llc;
 329     struct snap_header snap;
 330 });
 331 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
 332
 333 #define VLAN_VID_MASK 0x0fff
 334 #define VLAN_VID_SHIFT 0
 335
 336 #define VLAN_PCP_MASK 0xe000
 337 #define VLAN_PCP_SHIFT 13
 338
 339 #define VLAN_CFI 0x1000
 340 #define VLAN_CFI_SHIFT 12
 341
 342 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 343  * returns the VLAN ID in host byte order. */
 344 static inline uint16_t
 345 vlan_tci_to_vid(ovs_be16 vlan_tci)
 346 {
 347     return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
 348 }
 349
 350 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 351  * returns the priority code point (PCP) in host byte order. */
 352 static inline int
 353 vlan_tci_to_pcp(ovs_be16 vlan_tci)
 354 {
 355     return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
 356 }
 357
 358 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 359  * returns the Canonical Format Indicator (CFI). */
 360 static inline int
 361 vlan_tci_to_cfi(ovs_be16 vlan_tci)
 362 {
 363     return (vlan_tci & htons(VLAN_CFI)) != 0;
 364 }
 365
 366 #define VLAN_HEADER_LEN 4
 367 struct vlan_header {
 368     ovs_be16 vlan_tci;          /* Lowest 12 bits are VLAN ID. */
 369     ovs_be16 vlan_next_type;
 370 };
 371 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
 372
 373 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
 374 OVS_PACKED(
 375 struct vlan_eth_header {
 376     uint8_t veth_dst[ETH_ADDR_LEN];
 377     uint8_t veth_src[ETH_ADDR_LEN];
 378     ovs_be16 veth_type;         /* Always htons(ETH_TYPE_VLAN). */
 379     ovs_be16 veth_tci;          /* Lowest 12 bits are VLAN ID. */
 380     ovs_be16 veth_next_type;
 381 });
 382 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
 383
 384 /* MPLS related definitions */
 385 #define MPLS_TTL_MASK       0x000000ff
 386 #define MPLS_TTL_SHIFT      0
 387
 388 #define MPLS_BOS_MASK       0x00000100
 389 #define MPLS_BOS_SHIFT      8
 390
 391 #define MPLS_TC_MASK        0x00000e00
 392 #define MPLS_TC_SHIFT       9
 393
 394 #define MPLS_LABEL_MASK     0xfffff000
 395 #define MPLS_LABEL_SHIFT    12
 396
 397 #define MPLS_HLEN           4
 398
 399 struct mpls_hdr {
 400     ovs_16aligned_be32 mpls_lse;
 401 };
 402 BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
 403
 404 /* Given a mpls label stack entry in network byte order
 405  * return mpls label in host byte order */
 406 static inline uint32_t
 407 mpls_lse_to_label(ovs_be32 mpls_lse)
 408 {
 409     return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
 410 }
 411
 412 /* Given a mpls label stack entry in network byte order
 413  * return mpls tc */
 414 static inline uint8_t
 415 mpls_lse_to_tc(ovs_be32 mpls_lse)
 416 {
 417     return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
 418 }
 419
 420 /* Given a mpls label stack entry in network byte order
 421  * return mpls ttl */
 422 static inline uint8_t
 423 mpls_lse_to_ttl(ovs_be32 mpls_lse)
 424 {
 425     return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
 426 }
 427
 428 /* Set TTL in mpls lse. */
 429 static inline void
 430 flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
 431 {
 432     *mpls_lse &= ~htonl(MPLS_TTL_MASK);
 433     *mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
 434 }
 435
 436 /* Given a mpls label stack entry in network byte order
 437  * return mpls BoS bit  */
 438 static inline uint8_t
 439 mpls_lse_to_bos(ovs_be32 mpls_lse)
 440 {
 441     return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
 442 }
 443
 444 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
 445 #define IP_ARGS(ip)                             \
 446     ntohl(ip) >> 24,                            \
 447     (ntohl(ip) >> 16) & 0xff,                   \
 448     (ntohl(ip) >> 8) & 0xff,                    \
 449     ntohl(ip) & 0xff
 450
 451 /* Example:
 452  *
 453  * char *string = "1 33.44.55.66 2";
 454  * ovs_be32 ip;
 455  * int a, b;
 456  *
 457  * if (ovs_scan(string, "%d"IP_SCAN_FMT"%d", &a, IP_SCAN_ARGS(&ip), &b)) {
 458  *     ...
 459  * }
 460  */
 461 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
 462 #define IP_SCAN_ARGS(ip)                                    \
 463         ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]),    \
 464         &((uint8_t *) ip)[1],                               \
 465         &((uint8_t *) ip)[2],                               \
 466         &((uint8_t *) ip)[3]
 467
 468 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 469  * high-order 1-bits and 32-N low-order 0-bits. */
 470 static inline bool
 471 ip_is_cidr(ovs_be32 netmask)
 472 {
 473     uint32_t x = ~ntohl(netmask);
 474     return !(x & (x + 1));
 475 }
 476 static inline bool
 477 ip_is_multicast(ovs_be32 ip)
 478 {
 479     return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
 480 }
 481 static inline bool
 482 ip_is_local_multicast(ovs_be32 ip)
 483 {
 484     return (ip & htonl(0xffffff00)) == htonl(0xe0000000);
 485 }
 486 int ip_count_cidr_bits(ovs_be32 netmask);
 487 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
 488
 489 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
 490 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
 491 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
 492
 493 #ifndef IPPROTO_SCTP
 494 #define IPPROTO_SCTP 132
 495 #endif
 496
 497 /* TOS fields. */
 498 #define IP_ECN_NOT_ECT 0x0
 499 #define IP_ECN_ECT_1 0x01
 500 #define IP_ECN_ECT_0 0x02
 501 #define IP_ECN_CE 0x03
 502 #define IP_ECN_MASK 0x03
 503 #define IP_DSCP_MASK 0xfc
 504
 505 #define IP_VERSION 4
 506
 507 #define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
 508 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
 509 #define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
 510 #define IP_IS_FRAGMENT(ip_frag_off) \
 511         ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
 512
 513 #define IP_HEADER_LEN 20
 514 struct ip_header {
 515     uint8_t ip_ihl_ver;
 516     uint8_t ip_tos;
 517     ovs_be16 ip_tot_len;
 518     ovs_be16 ip_id;
 519     ovs_be16 ip_frag_off;
 520     uint8_t ip_ttl;
 521     uint8_t ip_proto;
 522     ovs_be16 ip_csum;
 523     ovs_16aligned_be32 ip_src;
 524     ovs_16aligned_be32 ip_dst;
 525 };
 526
 527 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
 528
 529 #define ICMP_HEADER_LEN 8
 530 struct icmp_header {
 531     uint8_t icmp_type;
 532     uint8_t icmp_code;
 533     ovs_be16 icmp_csum;
 534     union {
 535         struct {
 536             ovs_be16 id;
 537             ovs_be16 seq;
 538         } echo;
 539         struct {
 540             ovs_be16 empty;
 541             ovs_be16 mtu;
 542         } frag;
 543         ovs_16aligned_be32 gateway;
 544     } icmp_fields;
 545 };
 546 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
 547
 548 #define IGMP_HEADER_LEN 8
 549 struct igmp_header {
 550     uint8_t igmp_type;
 551     uint8_t igmp_code;
 552     ovs_be16 igmp_csum;
 553     ovs_16aligned_be32 group;
 554 };
 555 BUILD_ASSERT_DECL(IGMP_HEADER_LEN == sizeof(struct igmp_header));
 556
 557 #define IGMPV3_HEADER_LEN 8
 558 struct igmpv3_header {
 559     uint8_t type;
 560     uint8_t rsvr1;
 561     ovs_be16 csum;
 562     ovs_be16 rsvr2;
 563     ovs_be16 ngrp;
 564 };
 565 BUILD_ASSERT_DECL(IGMPV3_HEADER_LEN == sizeof(struct igmpv3_header));
 566
 567 #define IGMPV3_RECORD_LEN 8
 568 struct igmpv3_record {
 569     uint8_t type;
 570     uint8_t aux_len;
 571     ovs_be16 nsrcs;
 572     ovs_16aligned_be32 maddr;
 573 };
 574 BUILD_ASSERT_DECL(IGMPV3_RECORD_LEN == sizeof(struct igmpv3_record));
 575
 576 #define IGMP_HOST_MEMBERSHIP_QUERY    0x11 /* From RFC1112 */
 577 #define IGMP_HOST_MEMBERSHIP_REPORT   0x12 /* Ditto */
 578 #define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x12 */
 579 #define IGMP_HOST_LEAVE_MESSAGE       0x17
 580 #define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x12 */
 581
 582 /*
 583  * IGMPv3 and MLDv2 use the same codes.
 584  */
 585 #define IGMPV3_MODE_IS_INCLUDE 1
 586 #define IGMPV3_MODE_IS_EXCLUDE 2
 587 #define IGMPV3_CHANGE_TO_INCLUDE_MODE 3
 588 #define IGMPV3_CHANGE_TO_EXCLUDE_MODE 4
 589 #define IGMPV3_ALLOW_NEW_SOURCES 5
 590 #define IGMPV3_BLOCK_OLD_SOURCES 6
 591
 592 #define SCTP_HEADER_LEN 12
 593 struct sctp_header {
 594     ovs_be16 sctp_src;
 595     ovs_be16 sctp_dst;
 596     ovs_16aligned_be32 sctp_vtag;
 597     ovs_16aligned_be32 sctp_csum;
 598 };
 599 BUILD_ASSERT_DECL(SCTP_HEADER_LEN == sizeof(struct sctp_header));
 600
 601 #define UDP_HEADER_LEN 8
 602 struct udp_header {
 603     ovs_be16 udp_src;
 604     ovs_be16 udp_dst;
 605     ovs_be16 udp_len;
 606     ovs_be16 udp_csum;
 607 };
 608 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
 609
 610 #define TCP_FIN 0x001
 611 #define TCP_SYN 0x002
 612 #define TCP_RST 0x004
 613 #define TCP_PSH 0x008
 614 #define TCP_ACK 0x010
 615 #define TCP_URG 0x020
 616 #define TCP_ECE 0x040
 617 #define TCP_CWR 0x080
 618 #define TCP_NS  0x100
 619
 620 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
 621 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
 622 #define TCP_FLAGS_BE16(tcp_ctl) ((tcp_ctl) & htons(0x0fff))
 623 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
 624
 625 #define TCP_HEADER_LEN 20
 626 struct tcp_header {
 627     ovs_be16 tcp_src;
 628     ovs_be16 tcp_dst;
 629     ovs_16aligned_be32 tcp_seq;
 630     ovs_16aligned_be32 tcp_ack;
 631     ovs_be16 tcp_ctl;
 632     ovs_be16 tcp_winsz;
 633     ovs_be16 tcp_csum;
 634     ovs_be16 tcp_urg;
 635 };
 636 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
 637
 638 #define ARP_HRD_ETHERNET 1
 639 #define ARP_PRO_IP 0x0800
 640 #define ARP_OP_REQUEST 1
 641 #define ARP_OP_REPLY 2
 642 #define ARP_OP_RARP 3
 643
 644 #define ARP_ETH_HEADER_LEN 28
 645 struct arp_eth_header {
 646     /* Generic members. */
 647     ovs_be16 ar_hrd;           /* Hardware type. */
 648     ovs_be16 ar_pro;           /* Protocol type. */
 649     uint8_t ar_hln;            /* Hardware address length. */
 650     uint8_t ar_pln;            /* Protocol address length. */
 651     ovs_be16 ar_op;            /* Opcode. */
 652
 653     /* Ethernet+IPv4 specific members. */
 654     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
 655     ovs_16aligned_be32 ar_spa;           /* Sender protocol address. */
 656     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
 657     ovs_16aligned_be32 ar_tpa;           /* Target protocol address. */
 658 };
 659 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
 660
 661 /* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
 662  * most implementations, this one only requires 16-bit alignment. */
 663 union ovs_16aligned_in6_addr {
 664     ovs_be16 be16[8];
 665     ovs_16aligned_be32 be32[4];
 666 };
 667
 668 /* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
 669  * one only requires 16-bit alignment. */
 670 struct ovs_16aligned_ip6_hdr {
 671     union {
 672         struct ovs_16aligned_ip6_hdrctl {
 673             ovs_16aligned_be32 ip6_un1_flow;
 674             ovs_be16 ip6_un1_plen;
 675             uint8_t ip6_un1_nxt;
 676             uint8_t ip6_un1_hlim;
 677         } ip6_un1;
 678         uint8_t ip6_un2_vfc;
 679     } ip6_ctlun;
 680     union ovs_16aligned_in6_addr ip6_src;
 681     union ovs_16aligned_in6_addr ip6_dst;
 682 };
 683
 684 /* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
 685  * this one only requires 16-bit alignment. */
 686 struct ovs_16aligned_ip6_frag {
 687     uint8_t ip6f_nxt;
 688     uint8_t ip6f_reserved;
 689     ovs_be16 ip6f_offlg;
 690     ovs_16aligned_be32 ip6f_ident;
 691 };
 692
 693 #define ICMP6_HEADER_LEN 4
 694 struct icmp6_header {
 695     uint8_t icmp6_type;
 696     uint8_t icmp6_code;
 697     ovs_be16 icmp6_cksum;
 698 };
 699 BUILD_ASSERT_DECL(ICMP6_HEADER_LEN == sizeof(struct icmp6_header));
 700
 701 /* Neighbor Discovery option field.
 702  * ND options are always a multiple of 8 bytes in size. */
 703 #define ND_OPT_LEN 8
 704 struct ovs_nd_opt {
 705     uint8_t  nd_opt_type;      /* Values defined in icmp6.h */
 706     uint8_t  nd_opt_len;       /* in units of 8 octets (the size of this struct) */
 707     uint8_t  nd_opt_data[6];   /* Ethernet address in the case of SLL or TLL options */
 708 };
 709 BUILD_ASSERT_DECL(ND_OPT_LEN == sizeof(struct ovs_nd_opt));
 710
 711 /* Like struct nd_msg (from ndisc.h), but whereas that struct requires 32-bit
 712  * alignment, this one only requires 16-bit alignment. */
 713 #define ND_MSG_LEN 24
 714 struct ovs_nd_msg {
 715     struct icmp6_header icmph;
 716     ovs_16aligned_be32 rco_flags;
 717     union ovs_16aligned_in6_addr target;
 718     struct ovs_nd_opt options[0];
 719 };
 720 BUILD_ASSERT_DECL(ND_MSG_LEN == sizeof(struct ovs_nd_msg));
 721
 722 /*
 723  * Use the same struct for MLD and MLD2, naming members as the defined fields in
 724  * in the corresponding version of the protocol, though they are reserved in the
 725  * other one.
 726  */
 727 #define MLD_HEADER_LEN 8
 728 struct mld_header {
 729     uint8_t type;
 730     uint8_t code;
 731     ovs_be16 csum;
 732     ovs_be16 mrd;
 733     ovs_be16 ngrp;
 734 };
 735 BUILD_ASSERT_DECL(MLD_HEADER_LEN == sizeof(struct mld_header));
 736
 737 #define MLD2_RECORD_LEN 20
 738 struct mld2_record {
 739     uint8_t type;
 740     uint8_t aux_len;
 741     ovs_be16 nsrcs;
 742     union ovs_16aligned_in6_addr maddr;
 743 };
 744 BUILD_ASSERT_DECL(MLD2_RECORD_LEN == sizeof(struct mld2_record));
 745
 746 #define MLD_QUERY 130
 747 #define MLD_REPORT 131
 748 #define MLD_DONE 132
 749 #define MLD2_REPORT 143
 750
 751 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
 752 #define IPV6_LABEL_MASK 0x000fffff
 753
 754 /* Example:
 755  *
 756  * char *string = "1 ::1 2";
 757  * char ipv6_s[IPV6_SCAN_LEN + 1];
 758  * struct in6_addr ipv6;
 759  *
 760  * if (ovs_scan(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b)
 761  *     && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
 762  *     ...
 763  * }
 764  */
 765 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
 766 #define IPV6_SCAN_LEN 46
 767
 768 extern const struct in6_addr in6addr_exact;
 769 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
 770                                  0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
 771
 772 extern const struct in6_addr in6addr_all_hosts;
 773 #define IN6ADDR_ALL_HOSTS_INIT { { { 0xff,0x02,0x00,0x00,0x00,0x00,0x00,0x00, \
 774                                      0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01 } } }
 775
 776 static inline bool ipv6_addr_equals(const struct in6_addr *a,
 777                                     const struct in6_addr *b)
 778 {
 779 #ifdef IN6_ARE_ADDR_EQUAL
 780     return IN6_ARE_ADDR_EQUAL(a, b);
 781 #else
 782     return !memcmp(a, b, sizeof(*a));
 783 #endif
 784 }
 785
 786 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
 787     return ipv6_addr_equals(mask, &in6addr_any);
 788 }
 789
 790 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
 791     return ipv6_addr_equals(mask, &in6addr_exact);
 792 }
 793
 794 static inline bool ipv6_is_all_hosts(const struct in6_addr *addr) {
 795     return ipv6_addr_equals(addr, &in6addr_all_hosts);
 796 }
 797
 798 static inline bool dl_type_is_ip_any(ovs_be16 dl_type)
 799 {
 800     return dl_type == htons(ETH_TYPE_IP)
 801         || dl_type == htons(ETH_TYPE_IPV6);
 802 }
 803
 804 /* Tunnel header */
 805 #define GENEVE_MAX_OPT_SIZE 124
 806 #define GENEVE_TOT_OPT_SIZE 252
 807
 808 #define GENEVE_CRIT_OPT_TYPE (1 << 7)
 809
 810 struct geneve_opt {
 811     ovs_be16  opt_class;
 812     uint8_t   type;
 813 #ifdef WORDS_BIGENDIAN
 814     uint8_t   r1:1;
 815     uint8_t   r2:1;
 816     uint8_t   r3:1;
 817     uint8_t   length:5;
 818 #else
 819     uint8_t   length:5;
 820     uint8_t   r3:1;
 821     uint8_t   r2:1;
 822     uint8_t   r1:1;
 823 #endif
 824     /* Option data */
 825 };
 826
 827 struct genevehdr {
 828 #ifdef WORDS_BIGENDIAN
 829     uint8_t ver:2;
 830     uint8_t opt_len:6;
 831     uint8_t oam:1;
 832     uint8_t critical:1;
 833     uint8_t rsvd1:6;
 834 #else
 835     uint8_t opt_len:6;
 836     uint8_t ver:2;
 837     uint8_t rsvd1:6;
 838     uint8_t critical:1;
 839     uint8_t oam:1;
 840 #endif
 841     ovs_be16 proto_type;
 842     ovs_16aligned_be32 vni;
 843     struct geneve_opt options[];
 844 };
 845
 846 /* GRE protocol header */
 847 struct gre_base_hdr {
 848     ovs_be16 flags;
 849     ovs_be16 protocol;
 850 };
 851
 852 #define GRE_CSUM        0x8000
 853 #define GRE_ROUTING     0x4000
 854 #define GRE_KEY         0x2000
 855 #define GRE_SEQ         0x1000
 856 #define GRE_STRICT      0x0800
 857 #define GRE_REC         0x0700
 858 #define GRE_FLAGS       0x00F8
 859 #define GRE_VERSION     0x0007
 860
 861 /* VXLAN protocol header */
 862 struct vxlanhdr {
 863     ovs_16aligned_be32 vx_flags;
 864     ovs_16aligned_be32 vx_vni;
 865 };
 866
 867 #define VXLAN_FLAGS 0x08000000  /* struct vxlanhdr.vx_flags required value. */
 868
 869 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
 870 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
 871 void print_ipv6_mapped(struct ds *string, const struct in6_addr *addr);
 872 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
 873                        const struct in6_addr *mask);
 874 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
 875                                  const struct in6_addr *mask);
 876 struct in6_addr ipv6_create_mask(int mask);
 877 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
 878 bool ipv6_is_cidr(const struct in6_addr *netmask);
 879
 880 void *eth_compose(struct dp_packet *, const uint8_t eth_dst[ETH_ADDR_LEN],
 881                   const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
 882                   size_t size);
 883 void *snap_compose(struct dp_packet *, const uint8_t eth_dst[ETH_ADDR_LEN],
 884                    const uint8_t eth_src[ETH_ADDR_LEN],
 885                    unsigned int oui, uint16_t snap_type, size_t size);
 886 void packet_set_ipv4(struct dp_packet *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
 887                      uint8_t ttl);
 888 void packet_set_ipv6(struct dp_packet *, uint8_t proto, const ovs_be32 src[4],
 889                      const ovs_be32 dst[4], uint8_t tc,
 890                      ovs_be32 fl, uint8_t hlmit);
 891 void packet_set_tcp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
 892 void packet_set_udp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
 893 void packet_set_sctp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
 894 void packet_set_nd(struct dp_packet *, const ovs_be32 target[4],
 895                    const uint8_t sll[6], const uint8_t tll[6]);
 896
 897 void packet_format_tcp_flags(struct ds *, uint16_t);
 898 const char *packet_tcp_flag_to_string(uint32_t flag);
 899 void compose_arp(struct dp_packet *, uint16_t arp_op,
 900                  const uint8_t arp_sha[ETH_ADDR_LEN],
 901                  const uint8_t arp_tha[ETH_ADDR_LEN], bool broadcast,
 902                  ovs_be32 arp_spa, ovs_be32 arp_tpa);
 903 uint32_t packet_csum_pseudoheader(const struct ip_header *);
 904
 905 #endif /* packets.h */