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