lib/packets.h

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