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