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[6])
  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[6])
  92 {
  93     return ea[0] & 1;
  94 }
  95 static inline bool eth_addr_is_local(const uint8_t ea[6])
  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[6])
 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_VLAN_8021Q    0x8100
 240 #define ETH_TYPE_VLAN          ETH_TYPE_VLAN_8021Q
 241 #define ETH_TYPE_VLAN_8021AD   0x88a8
 242 #define ETH_TYPE_IPV6          0x86dd
 243 #define ETH_TYPE_LACP          0x8809
 244 #define ETH_TYPE_RARP          0x8035
 245 #define ETH_TYPE_MPLS          0x8847
 246 #define ETH_TYPE_MPLS_MCAST    0x8848
 247
 248 static inline bool eth_type_mpls(ovs_be16 eth_type)
 249 {
 250     return eth_type == htons(ETH_TYPE_MPLS) ||
 251         eth_type == htons(ETH_TYPE_MPLS_MCAST);
 252 }
 253
 254 /* Minimum value for an Ethernet type.  Values below this are IEEE 802.2 frame
 255  * lengths. */
 256 #define ETH_TYPE_MIN           0x600
 257
 258 #define ETH_HEADER_LEN 14
 259 #define ETH_PAYLOAD_MIN 46
 260 #define ETH_PAYLOAD_MAX 1500
 261 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
 262 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
 263 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
 264 OVS_PACKED(
 265 struct eth_header {
 266     uint8_t eth_dst[ETH_ADDR_LEN];
 267     uint8_t eth_src[ETH_ADDR_LEN];
 268     ovs_be16 eth_type;
 269 });
 270 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
 271
 272 #define LLC_DSAP_SNAP 0xaa
 273 #define LLC_SSAP_SNAP 0xaa
 274 #define LLC_CNTL_SNAP 3
 275
 276 #define LLC_HEADER_LEN 3
 277 OVS_PACKED(
 278 struct llc_header {
 279     uint8_t llc_dsap;
 280     uint8_t llc_ssap;
 281     uint8_t llc_cntl;
 282 });
 283 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
 284
 285 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
 286                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
 287 #define SNAP_HEADER_LEN 5
 288 OVS_PACKED(
 289 struct snap_header {
 290     uint8_t snap_org[3];
 291     ovs_be16 snap_type;
 292 });
 293 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
 294
 295 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
 296 OVS_PACKED(
 297 struct llc_snap_header {
 298     struct llc_header llc;
 299     struct snap_header snap;
 300 });
 301 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
 302
 303 #define VLAN_VID_MASK 0x0fff
 304 #define VLAN_VID_SHIFT 0
 305
 306 #define VLAN_PCP_MASK 0xe000
 307 #define VLAN_PCP_SHIFT 13
 308
 309 #define VLAN_CFI 0x1000
 310 #define VLAN_CFI_SHIFT 12
 311
 312 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 313  * returns the VLAN ID in host byte order. */
 314 static inline uint16_t
 315 vlan_tci_to_vid(ovs_be16 vlan_tci)
 316 {
 317     return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
 318 }
 319
 320 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 321  * returns the priority code point (PCP) in host byte order. */
 322 static inline int
 323 vlan_tci_to_pcp(ovs_be16 vlan_tci)
 324 {
 325     return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
 326 }
 327
 328 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 329  * returns the Canonical Format Indicator (CFI). */
 330 static inline int
 331 vlan_tci_to_cfi(ovs_be16 vlan_tci)
 332 {
 333     return (vlan_tci & htons(VLAN_CFI)) != 0;
 334 }
 335
 336 #define VLAN_HEADER_LEN 4
 337 struct vlan_header {
 338     ovs_be16 vlan_tci;          /* Lowest 12 bits are VLAN ID. */
 339     ovs_be16 vlan_next_type;
 340 };
 341 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
 342
 343 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
 344 OVS_PACKED(
 345 struct vlan_eth_header {
 346     uint8_t veth_dst[ETH_ADDR_LEN];
 347     uint8_t veth_src[ETH_ADDR_LEN];
 348     ovs_be16 veth_type;         /* Always htons(ETH_TYPE_VLAN). */
 349     ovs_be16 veth_tci;          /* Lowest 12 bits are VLAN ID. */
 350     ovs_be16 veth_next_type;
 351 });
 352 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
 353
 354 /* MPLS related definitions */
 355 #define MPLS_TTL_MASK       0x000000ff
 356 #define MPLS_TTL_SHIFT      0
 357
 358 #define MPLS_BOS_MASK       0x00000100
 359 #define MPLS_BOS_SHIFT      8
 360
 361 #define MPLS_TC_MASK        0x00000e00
 362 #define MPLS_TC_SHIFT       9
 363
 364 #define MPLS_LABEL_MASK     0xfffff000
 365 #define MPLS_LABEL_SHIFT    12
 366
 367 #define MPLS_HLEN           4
 368
 369 struct mpls_hdr {
 370     ovs_16aligned_be32 mpls_lse;
 371 };
 372 BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
 373
 374 /* Given a mpls label stack entry in network byte order
 375  * return mpls label in host byte order */
 376 static inline uint32_t
 377 mpls_lse_to_label(ovs_be32 mpls_lse)
 378 {
 379     return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
 380 }
 381
 382 /* Given a mpls label stack entry in network byte order
 383  * return mpls tc */
 384 static inline uint8_t
 385 mpls_lse_to_tc(ovs_be32 mpls_lse)
 386 {
 387     return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
 388 }
 389
 390 /* Given a mpls label stack entry in network byte order
 391  * return mpls ttl */
 392 static inline uint8_t
 393 mpls_lse_to_ttl(ovs_be32 mpls_lse)
 394 {
 395     return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
 396 }
 397
 398 /* Set TTL in mpls lse. */
 399 static inline void
 400 flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
 401 {
 402     *mpls_lse &= ~htonl(MPLS_TTL_MASK);
 403     *mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
 404 }
 405
 406 /* Given a mpls label stack entry in network byte order
 407  * return mpls BoS bit  */
 408 static inline uint8_t
 409 mpls_lse_to_bos(ovs_be32 mpls_lse)
 410 {
 411     return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
 412 }
 413
 414 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
 415 #define IP_ARGS(ip)                             \
 416     ntohl(ip) >> 24,                            \
 417     (ntohl(ip) >> 16) & 0xff,                   \
 418     (ntohl(ip) >> 8) & 0xff,                    \
 419     ntohl(ip) & 0xff
 420
 421 /* Example:
 422  *
 423  * char *string = "1 33.44.55.66 2";
 424  * ovs_be32 ip;
 425  * int a, b;
 426  *
 427  * if (ovs_scan(string, "%d"IP_SCAN_FMT"%d", &a, IP_SCAN_ARGS(&ip), &b)) {
 428  *     ...
 429  * }
 430  */
 431 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
 432 #define IP_SCAN_ARGS(ip)                                    \
 433         ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]),    \
 434         &((uint8_t *) ip)[1],                               \
 435         &((uint8_t *) ip)[2],                               \
 436         &((uint8_t *) ip)[3]
 437
 438 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 439  * high-order 1-bits and 32-N low-order 0-bits. */
 440 static inline bool
 441 ip_is_cidr(ovs_be32 netmask)
 442 {
 443     uint32_t x = ~ntohl(netmask);
 444     return !(x & (x + 1));
 445 }
 446 static inline bool
 447 ip_is_multicast(ovs_be32 ip)
 448 {
 449     return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
 450 }
 451 static inline bool
 452 ip_is_local_multicast(ovs_be32 ip)
 453 {
 454     return (ip & htonl(0xffffff00)) == htonl(0xe0000000);
 455 }
 456 int ip_count_cidr_bits(ovs_be32 netmask);
 457 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
 458
 459 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
 460 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
 461 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
 462
 463 #ifndef IPPROTO_SCTP
 464 #define IPPROTO_SCTP 132
 465 #endif
 466
 467 /* TOS fields. */
 468 #define IP_ECN_NOT_ECT 0x0
 469 #define IP_ECN_ECT_1 0x01
 470 #define IP_ECN_ECT_0 0x02
 471 #define IP_ECN_CE 0x03
 472 #define IP_ECN_MASK 0x03
 473 #define IP_DSCP_MASK 0xfc
 474
 475 #define IP_VERSION 4
 476
 477 #define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
 478 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
 479 #define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
 480 #define IP_IS_FRAGMENT(ip_frag_off) \
 481         ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
 482
 483 #define IP_HEADER_LEN 20
 484 struct ip_header {
 485     uint8_t ip_ihl_ver;
 486     uint8_t ip_tos;
 487     ovs_be16 ip_tot_len;
 488     ovs_be16 ip_id;
 489     ovs_be16 ip_frag_off;
 490     uint8_t ip_ttl;
 491     uint8_t ip_proto;
 492     ovs_be16 ip_csum;
 493     ovs_16aligned_be32 ip_src;
 494     ovs_16aligned_be32 ip_dst;
 495 };
 496 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
 497
 498 #define ICMP_HEADER_LEN 8
 499 struct icmp_header {
 500     uint8_t icmp_type;
 501     uint8_t icmp_code;
 502     ovs_be16 icmp_csum;
 503     union {
 504         struct {
 505             ovs_be16 id;
 506             ovs_be16 seq;
 507         } echo;
 508         struct {
 509             ovs_be16 empty;
 510             ovs_be16 mtu;
 511         } frag;
 512         ovs_16aligned_be32 gateway;
 513     } icmp_fields;
 514     uint8_t icmp_data[0];
 515 };
 516 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
 517
 518 #define IGMP_HEADER_LEN 8
 519 struct igmp_header {
 520     uint8_t igmp_type;
 521     uint8_t igmp_code;
 522     ovs_be16 igmp_csum;
 523     ovs_16aligned_be32 group;
 524 };
 525 BUILD_ASSERT_DECL(IGMP_HEADER_LEN == sizeof(struct igmp_header));
 526
 527 #define IGMP_HOST_MEMBERSHIP_QUERY    0x11 /* From RFC1112 */
 528 #define IGMP_HOST_MEMBERSHIP_REPORT   0x12 /* Ditto */
 529 #define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x12 */
 530 #define IGMP_HOST_LEAVE_MESSAGE       0x17
 531 #define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x12 */
 532
 533 #define SCTP_HEADER_LEN 12
 534 struct sctp_header {
 535     ovs_be16 sctp_src;
 536     ovs_be16 sctp_dst;
 537     ovs_16aligned_be32 sctp_vtag;
 538     ovs_16aligned_be32 sctp_csum;
 539 };
 540 BUILD_ASSERT_DECL(SCTP_HEADER_LEN == sizeof(struct sctp_header));
 541
 542 #define UDP_HEADER_LEN 8
 543 struct udp_header {
 544     ovs_be16 udp_src;
 545     ovs_be16 udp_dst;
 546     ovs_be16 udp_len;
 547     ovs_be16 udp_csum;
 548 };
 549 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
 550
 551 #define TCP_FIN 0x001
 552 #define TCP_SYN 0x002
 553 #define TCP_RST 0x004
 554 #define TCP_PSH 0x008
 555 #define TCP_ACK 0x010
 556 #define TCP_URG 0x020
 557 #define TCP_ECE 0x040
 558 #define TCP_CWR 0x080
 559 #define TCP_NS  0x100
 560
 561 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
 562 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
 563 #define TCP_FLAGS_BE16(tcp_ctl) ((tcp_ctl) & htons(0x0fff))
 564 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
 565
 566 #define TCP_HEADER_LEN 20
 567 struct tcp_header {
 568     ovs_be16 tcp_src;
 569     ovs_be16 tcp_dst;
 570     ovs_16aligned_be32 tcp_seq;
 571     ovs_16aligned_be32 tcp_ack;
 572     ovs_be16 tcp_ctl;
 573     ovs_be16 tcp_winsz;
 574     ovs_be16 tcp_csum;
 575     ovs_be16 tcp_urg;
 576 };
 577 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
 578
 579 #define ARP_HRD_ETHERNET 1
 580 #define ARP_PRO_IP 0x0800
 581 #define ARP_OP_REQUEST 1
 582 #define ARP_OP_REPLY 2
 583 #define ARP_OP_RARP 3
 584
 585 #define ARP_ETH_HEADER_LEN 28
 586 struct arp_eth_header {
 587     /* Generic members. */
 588     ovs_be16 ar_hrd;           /* Hardware type. */
 589     ovs_be16 ar_pro;           /* Protocol type. */
 590     uint8_t ar_hln;            /* Hardware address length. */
 591     uint8_t ar_pln;            /* Protocol address length. */
 592     ovs_be16 ar_op;            /* Opcode. */
 593
 594     /* Ethernet+IPv4 specific members. */
 595     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
 596     ovs_16aligned_be32 ar_spa;           /* Sender protocol address. */
 597     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
 598     ovs_16aligned_be32 ar_tpa;           /* Target protocol address. */
 599 };
 600 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
 601
 602 /* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
 603  * most implementations, this one only requires 16-bit alignment. */
 604 union ovs_16aligned_in6_addr {
 605     ovs_be16 be16[8];
 606     ovs_16aligned_be32 be32[4];
 607 };
 608
 609 /* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
 610  * one only requires 16-bit alignment. */
 611 struct ovs_16aligned_ip6_hdr {
 612     union {
 613         struct ovs_16aligned_ip6_hdrctl {
 614             ovs_16aligned_be32 ip6_un1_flow;
 615             ovs_be16 ip6_un1_plen;
 616             uint8_t ip6_un1_nxt;
 617             uint8_t ip6_un1_hlim;
 618         } ip6_un1;
 619         uint8_t ip6_un2_vfc;
 620     } ip6_ctlun;
 621     union ovs_16aligned_in6_addr ip6_src;
 622     union ovs_16aligned_in6_addr ip6_dst;
 623 };
 624
 625 /* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
 626  * this one only requires 16-bit alignment. */
 627 struct ovs_16aligned_ip6_frag {
 628     uint8_t ip6f_nxt;
 629     uint8_t ip6f_reserved;
 630     ovs_be16 ip6f_offlg;
 631     ovs_16aligned_be32 ip6f_ident;
 632 };
 633
 634 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
 635 #define IPV6_LABEL_MASK 0x000fffff
 636
 637 /* Example:
 638  *
 639  * char *string = "1 ::1 2";
 640  * char ipv6_s[IPV6_SCAN_LEN + 1];
 641  * struct in6_addr ipv6;
 642  *
 643  * if (ovs_scan(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b)
 644  *     && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
 645  *     ...
 646  * }
 647  */
 648 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
 649 #define IPV6_SCAN_LEN 46
 650
 651 extern const struct in6_addr in6addr_exact;
 652 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
 653                                  0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
 654
 655 static inline bool ipv6_addr_equals(const struct in6_addr *a,
 656                                     const struct in6_addr *b)
 657 {
 658 #ifdef IN6_ARE_ADDR_EQUAL
 659     return IN6_ARE_ADDR_EQUAL(a, b);
 660 #else
 661     return !memcmp(a, b, sizeof(*a));
 662 #endif
 663 }
 664
 665 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
 666     return ipv6_addr_equals(mask, &in6addr_any);
 667 }
 668
 669 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
 670     return ipv6_addr_equals(mask, &in6addr_exact);
 671 }
 672
 673 static inline bool dl_type_is_ip_any(ovs_be16 dl_type)
 674 {
 675     return dl_type == htons(ETH_TYPE_IP)
 676         || dl_type == htons(ETH_TYPE_IPV6);
 677 }
 678
 679 #define GENEVE_CRIT_OPT_TYPE (1 << 7)
 680 struct geneve_opt {
 681     ovs_be16  opt_class;
 682     uint8_t   type;
 683 #ifdef LITTLE_ENDIAN
 684     uint8_t   length:5;
 685     uint8_t   r3:1;
 686     uint8_t   r2:1;
 687     uint8_t   r1:1;
 688 #else
 689     uint8_t   r1:1;
 690     uint8_t   r2:1;
 691     uint8_t   r3:1;
 692     uint8_t   length:5;
 693 #endif
 694     uint8_t   opt_data[];
 695 };
 696
 697 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
 698 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
 699 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
 700                        const struct in6_addr *mask);
 701 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
 702                                  const struct in6_addr *mask);
 703 struct in6_addr ipv6_create_mask(int mask);
 704 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
 705 bool ipv6_is_cidr(const struct in6_addr *netmask);
 706
 707 void *eth_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
 708                   const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
 709                   size_t size);
 710 void *snap_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
 711                    const uint8_t eth_src[ETH_ADDR_LEN],
 712                    unsigned int oui, uint16_t snap_type, size_t size);
 713 void packet_set_ipv4(struct ofpbuf *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
 714                      uint8_t ttl);
 715 void packet_set_ipv6(struct ofpbuf *, uint8_t proto, const ovs_be32 src[4],
 716                      const ovs_be32 dst[4], uint8_t tc,
 717                      ovs_be32 fl, uint8_t hlmit);
 718 void packet_set_tcp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
 719 void packet_set_udp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
 720 void packet_set_sctp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
 721
 722 void packet_format_tcp_flags(struct ds *, uint16_t);
 723 const char *packet_tcp_flag_to_string(uint32_t flag);
 724
 725 #endif /* packets.h */