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