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