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