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