lib/packets.h

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