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 "openvswitch/types.h"
  27 #include "random.h"
  28 #include "hash.h"
  29 #include "util.h"
  30
  31 struct dp_packet;
  32 struct ds;
  33
  34 /* Tunnel information used in flow key and metadata. */
  35 struct flow_tnl {
  36     ovs_be64 tun_id;
  37     ovs_be32 ip_src;
  38     ovs_be32 ip_dst;
  39     uint16_t flags;
  40     uint8_t ip_tos;
  41     uint8_t ip_ttl;
  42     ovs_be16 tp_src;
  43     ovs_be16 tp_dst;
  44     ovs_be16 gbp_id;
  45     uint8_t  gbp_flags;
  46     uint8_t  pad1[5];        /* Pad to 64 bits. */
  47 };
  48
  49 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
  50  * numbers and other times datapath (dpif) port numbers.  This union allows
  51  * access to both. */
  52 union flow_in_port {
  53     odp_port_t odp_port;
  54     ofp_port_t ofp_port;
  55 };
  56
  57 /* Datapath packet metadata */
  58 struct pkt_metadata {
  59     uint32_t recirc_id;         /* Recirculation id carried with the
  60                                    recirculating packets. 0 for packets
  61                                    received from the wire. */
  62     uint32_t dp_hash;           /* hash value computed by the recirculation
  63                                    action. */
  64     struct flow_tnl tunnel;     /* Encapsulating tunnel parameters. */
  65     uint32_t skb_priority;      /* Packet priority for QoS. */
  66     uint32_t pkt_mark;          /* Packet mark. */
  67     union flow_in_port in_port; /* Input port. */
  68 };
  69
  70 #define PKT_METADATA_INITIALIZER(PORT) \
  71     (struct pkt_metadata){ .in_port.odp_port = PORT }
  72
  73 bool dpid_from_string(const char *s, uint64_t *dpidp);
  74
  75 #define ETH_ADDR_LEN           6
  76
  77 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
  78     = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
  79
  80 static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
  81     = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 };
  82
  83 static const uint8_t eth_addr_lacp[ETH_ADDR_LEN] OVS_UNUSED
  84     = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 };
  85
  86 static const uint8_t eth_addr_bfd[ETH_ADDR_LEN] OVS_UNUSED
  87     = { 0x00, 0x23, 0x20, 0x00, 0x00, 0x01 };
  88
  89 static inline bool eth_addr_is_broadcast(const uint8_t ea[ETH_ADDR_LEN])
  90 {
  91     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
  92 }
  93
  94 static inline bool eth_addr_is_multicast(const uint8_t ea[ETH_ADDR_LEN])
  95 {
  96     return ea[0] & 1;
  97 }
  98 static inline bool eth_addr_is_local(const uint8_t ea[ETH_ADDR_LEN])
  99 {
 100     /* Local if it is either a locally administered address or a Nicira random
 101      * address. */
 102     return ea[0] & 2
 103        || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && ea[3] & 0x80);
 104 }
 105 static inline bool eth_addr_is_zero(const uint8_t ea[ETH_ADDR_LEN])
 106 {
 107     return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
 108 }
 109
 110 static inline int eth_mask_is_exact(const uint8_t ea[ETH_ADDR_LEN])
 111 {
 112     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
 113 }
 114
 115 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
 116                                         const uint8_t b[ETH_ADDR_LEN])
 117 {
 118     return memcmp(a, b, ETH_ADDR_LEN);
 119 }
 120 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
 121                                    const uint8_t b[ETH_ADDR_LEN])
 122 {
 123     return !eth_addr_compare_3way(a, b);
 124 }
 125 static inline bool eth_addr_equal_except(const uint8_t a[ETH_ADDR_LEN],
 126                                     const uint8_t b[ETH_ADDR_LEN],
 127                                     const uint8_t mask[ETH_ADDR_LEN])
 128 {
 129     return !(((a[0] ^ b[0]) & mask[0])
 130              || ((a[1] ^ b[1]) & mask[1])
 131              || ((a[2] ^ b[2]) & mask[2])
 132              || ((a[3] ^ b[3]) & mask[3])
 133              || ((a[4] ^ b[4]) & mask[4])
 134              || ((a[5] ^ b[5]) & mask[5]));
 135 }
 136 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
 137 {
 138     return (((uint64_t) ea[0] << 40)
 139             | ((uint64_t) ea[1] << 32)
 140             | ((uint64_t) ea[2] << 24)
 141             | ((uint64_t) ea[3] << 16)
 142             | ((uint64_t) ea[4] << 8)
 143             | ea[5]);
 144 }
 145 static inline uint64_t eth_addr_vlan_to_uint64(const uint8_t ea[ETH_ADDR_LEN],
 146                                                uint16_t vlan)
 147 {
 148     return (((uint64_t)vlan << 48) | eth_addr_to_uint64(ea));
 149 }
 150 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
 151 {
 152     ea[0] = x >> 40;
 153     ea[1] = x >> 32;
 154     ea[2] = x >> 24;
 155     ea[3] = x >> 16;
 156     ea[4] = x >> 8;
 157     ea[5] = x;
 158 }
 159 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
 160 {
 161     ea[0] &= ~1;                /* Unicast. */
 162     ea[0] |= 2;                 /* Private. */
 163 }
 164 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
 165 {
 166     random_bytes(ea, ETH_ADDR_LEN);
 167     eth_addr_mark_random(ea);
 168 }
 169 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
 170 {
 171     eth_addr_random(ea);
 172
 173     /* Set the OUI to the Nicira one. */
 174     ea[0] = 0x00;
 175     ea[1] = 0x23;
 176     ea[2] = 0x20;
 177
 178     /* Set the top bit to indicate random Nicira address. */
 179     ea[3] |= 0x80;
 180 }
 181 static inline uint32_t hash_mac(const uint8_t ea[ETH_ADDR_LEN],
 182                                 const uint16_t vlan, const uint32_t basis)
 183 {
 184     return hash_uint64_basis(eth_addr_vlan_to_uint64(ea, vlan), basis);
 185 }
 186
 187 bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN]);
 188 bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
 189
 190 void compose_rarp(struct dp_packet *, const uint8_t eth_src[ETH_ADDR_LEN]);
 191
 192 void eth_push_vlan(struct dp_packet *, ovs_be16 tpid, ovs_be16 tci);
 193 void eth_pop_vlan(struct dp_packet *);
 194
 195 const char *eth_from_hex(const char *hex, struct dp_packet **packetp);
 196 void eth_format_masked(const uint8_t eth[ETH_ADDR_LEN],
 197                        const uint8_t mask[ETH_ADDR_LEN], struct ds *s);
 198 void eth_addr_bitand(const uint8_t src[ETH_ADDR_LEN],
 199                      const uint8_t mask[ETH_ADDR_LEN],
 200                      uint8_t dst[ETH_ADDR_LEN]);
 201
 202 void set_mpls_lse(struct dp_packet *, ovs_be32 label);
 203 void push_mpls(struct dp_packet *packet, ovs_be16 ethtype, ovs_be32 lse);
 204 void pop_mpls(struct dp_packet *, ovs_be16 ethtype);
 205
 206 void set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl);
 207 void set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc);
 208 void set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label);
 209 void set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos);
 210 ovs_be32 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos,
 211                              ovs_be32 label);
 212
 213 /* Example:
 214  *
 215  * uint8_t mac[ETH_ADDR_LEN];
 216  *    [...]
 217  * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
 218  *
 219  */
 220 #define ETH_ADDR_FMT                                                    \
 221     "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
 222 #define ETH_ADDR_ARGS(ea)                                   \
 223     (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
 224
 225 /* Example:
 226  *
 227  * char *string = "1 00:11:22:33:44:55 2";
 228  * uint8_t mac[ETH_ADDR_LEN];
 229  * int a, b;
 230  *
 231  * if (ovs_scan(string, "%d"ETH_ADDR_SCAN_FMT"%d",
 232  *              &a, ETH_ADDR_SCAN_ARGS(mac), &b)) {
 233  *     ...
 234  * }
 235  */
 236 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
 237 #define ETH_ADDR_SCAN_ARGS(ea) \
 238         &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
 239
 240 #define ETH_TYPE_IP            0x0800
 241 #define ETH_TYPE_ARP           0x0806
 242 #define ETH_TYPE_TEB           0x6558
 243 #define ETH_TYPE_VLAN_8021Q    0x8100
 244 #define ETH_TYPE_VLAN          ETH_TYPE_VLAN_8021Q
 245 #define ETH_TYPE_VLAN_8021AD   0x88a8
 246 #define ETH_TYPE_IPV6          0x86dd
 247 #define ETH_TYPE_LACP          0x8809
 248 #define ETH_TYPE_RARP          0x8035
 249 #define ETH_TYPE_MPLS          0x8847
 250 #define ETH_TYPE_MPLS_MCAST    0x8848
 251
 252 static inline bool eth_type_mpls(ovs_be16 eth_type)
 253 {
 254     return eth_type == htons(ETH_TYPE_MPLS) ||
 255         eth_type == htons(ETH_TYPE_MPLS_MCAST);
 256 }
 257
 258 static inline bool eth_type_vlan(ovs_be16 eth_type)
 259 {
 260     return eth_type == htons(ETH_TYPE_VLAN_8021Q) ||
 261         eth_type == htons(ETH_TYPE_VLAN_8021AD);
 262 }
 263
 264
 265 /* Minimum value for an Ethernet type.  Values below this are IEEE 802.2 frame
 266  * lengths. */
 267 #define ETH_TYPE_MIN           0x600
 268
 269 #define ETH_HEADER_LEN 14
 270 #define ETH_PAYLOAD_MIN 46
 271 #define ETH_PAYLOAD_MAX 1500
 272 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
 273 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
 274 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
 275 OVS_PACKED(
 276 struct eth_header {
 277     uint8_t eth_dst[ETH_ADDR_LEN];
 278     uint8_t eth_src[ETH_ADDR_LEN];
 279     ovs_be16 eth_type;
 280 });
 281 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
 282
 283 #define LLC_DSAP_SNAP 0xaa
 284 #define LLC_SSAP_SNAP 0xaa
 285 #define LLC_CNTL_SNAP 3
 286
 287 #define LLC_HEADER_LEN 3
 288 OVS_PACKED(
 289 struct llc_header {
 290     uint8_t llc_dsap;
 291     uint8_t llc_ssap;
 292     uint8_t llc_cntl;
 293 });
 294 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
 295
 296 /* LLC field values used for STP frames. */
 297 #define STP_LLC_SSAP 0x42
 298 #define STP_LLC_DSAP 0x42
 299 #define STP_LLC_CNTL 0x03
 300
 301 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
 302                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
 303 #define SNAP_HEADER_LEN 5
 304 OVS_PACKED(
 305 struct snap_header {
 306     uint8_t snap_org[3];
 307     ovs_be16 snap_type;
 308 });
 309 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
 310
 311 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
 312 OVS_PACKED(
 313 struct llc_snap_header {
 314     struct llc_header llc;
 315     struct snap_header snap;
 316 });
 317 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
 318
 319 #define VLAN_VID_MASK 0x0fff
 320 #define VLAN_VID_SHIFT 0
 321
 322 #define VLAN_PCP_MASK 0xe000
 323 #define VLAN_PCP_SHIFT 13
 324
 325 #define VLAN_CFI 0x1000
 326 #define VLAN_CFI_SHIFT 12
 327
 328 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 329  * returns the VLAN ID in host byte order. */
 330 static inline uint16_t
 331 vlan_tci_to_vid(ovs_be16 vlan_tci)
 332 {
 333     return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
 334 }
 335
 336 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 337  * returns the priority code point (PCP) in host byte order. */
 338 static inline int
 339 vlan_tci_to_pcp(ovs_be16 vlan_tci)
 340 {
 341     return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
 342 }
 343
 344 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
 345  * returns the Canonical Format Indicator (CFI). */
 346 static inline int
 347 vlan_tci_to_cfi(ovs_be16 vlan_tci)
 348 {
 349     return (vlan_tci & htons(VLAN_CFI)) != 0;
 350 }
 351
 352 #define VLAN_HEADER_LEN 4
 353 struct vlan_header {
 354     ovs_be16 vlan_tci;          /* Lowest 12 bits are VLAN ID. */
 355     ovs_be16 vlan_next_type;
 356 };
 357 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
 358
 359 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
 360 OVS_PACKED(
 361 struct vlan_eth_header {
 362     uint8_t veth_dst[ETH_ADDR_LEN];
 363     uint8_t veth_src[ETH_ADDR_LEN];
 364     ovs_be16 veth_type;         /* Always htons(ETH_TYPE_VLAN). */
 365     ovs_be16 veth_tci;          /* Lowest 12 bits are VLAN ID. */
 366     ovs_be16 veth_next_type;
 367 });
 368 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
 369
 370 /* MPLS related definitions */
 371 #define MPLS_TTL_MASK       0x000000ff
 372 #define MPLS_TTL_SHIFT      0
 373
 374 #define MPLS_BOS_MASK       0x00000100
 375 #define MPLS_BOS_SHIFT      8
 376
 377 #define MPLS_TC_MASK        0x00000e00
 378 #define MPLS_TC_SHIFT       9
 379
 380 #define MPLS_LABEL_MASK     0xfffff000
 381 #define MPLS_LABEL_SHIFT    12
 382
 383 #define MPLS_HLEN           4
 384
 385 struct mpls_hdr {
 386     ovs_16aligned_be32 mpls_lse;
 387 };
 388 BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
 389
 390 /* Given a mpls label stack entry in network byte order
 391  * return mpls label in host byte order */
 392 static inline uint32_t
 393 mpls_lse_to_label(ovs_be32 mpls_lse)
 394 {
 395     return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
 396 }
 397
 398 /* Given a mpls label stack entry in network byte order
 399  * return mpls tc */
 400 static inline uint8_t
 401 mpls_lse_to_tc(ovs_be32 mpls_lse)
 402 {
 403     return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
 404 }
 405
 406 /* Given a mpls label stack entry in network byte order
 407  * return mpls ttl */
 408 static inline uint8_t
 409 mpls_lse_to_ttl(ovs_be32 mpls_lse)
 410 {
 411     return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
 412 }
 413
 414 /* Set TTL in mpls lse. */
 415 static inline void
 416 flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
 417 {
 418     *mpls_lse &= ~htonl(MPLS_TTL_MASK);
 419     *mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
 420 }
 421
 422 /* Given a mpls label stack entry in network byte order
 423  * return mpls BoS bit  */
 424 static inline uint8_t
 425 mpls_lse_to_bos(ovs_be32 mpls_lse)
 426 {
 427     return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
 428 }
 429
 430 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
 431 #define IP_ARGS(ip)                             \
 432     ntohl(ip) >> 24,                            \
 433     (ntohl(ip) >> 16) & 0xff,                   \
 434     (ntohl(ip) >> 8) & 0xff,                    \
 435     ntohl(ip) & 0xff
 436
 437 /* Example:
 438  *
 439  * char *string = "1 33.44.55.66 2";
 440  * ovs_be32 ip;
 441  * int a, b;
 442  *
 443  * if (ovs_scan(string, "%d"IP_SCAN_FMT"%d", &a, IP_SCAN_ARGS(&ip), &b)) {
 444  *     ...
 445  * }
 446  */
 447 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
 448 #define IP_SCAN_ARGS(ip)                                    \
 449         ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]),    \
 450         &((uint8_t *) ip)[1],                               \
 451         &((uint8_t *) ip)[2],                               \
 452         &((uint8_t *) ip)[3]
 453
 454 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 455  * high-order 1-bits and 32-N low-order 0-bits. */
 456 static inline bool
 457 ip_is_cidr(ovs_be32 netmask)
 458 {
 459     uint32_t x = ~ntohl(netmask);
 460     return !(x & (x + 1));
 461 }
 462 static inline bool
 463 ip_is_multicast(ovs_be32 ip)
 464 {
 465     return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
 466 }
 467 static inline bool
 468 ip_is_local_multicast(ovs_be32 ip)
 469 {
 470     return (ip & htonl(0xffffff00)) == htonl(0xe0000000);
 471 }
 472 int ip_count_cidr_bits(ovs_be32 netmask);
 473 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
 474
 475 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
 476 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
 477 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
 478
 479 #ifndef IPPROTO_SCTP
 480 #define IPPROTO_SCTP 132
 481 #endif
 482
 483 /* TOS fields. */
 484 #define IP_ECN_NOT_ECT 0x0
 485 #define IP_ECN_ECT_1 0x01
 486 #define IP_ECN_ECT_0 0x02
 487 #define IP_ECN_CE 0x03
 488 #define IP_ECN_MASK 0x03
 489 #define IP_DSCP_MASK 0xfc
 490
 491 #define IP_VERSION 4
 492
 493 #define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
 494 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
 495 #define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
 496 #define IP_IS_FRAGMENT(ip_frag_off) \
 497         ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
 498
 499 #define IP_HEADER_LEN 20
 500 struct ip_header {
 501     uint8_t ip_ihl_ver;
 502     uint8_t ip_tos;
 503     ovs_be16 ip_tot_len;
 504     ovs_be16 ip_id;
 505     ovs_be16 ip_frag_off;
 506     uint8_t ip_ttl;
 507     uint8_t ip_proto;
 508     ovs_be16 ip_csum;
 509     ovs_16aligned_be32 ip_src;
 510     ovs_16aligned_be32 ip_dst;
 511 };
 512
 513 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
 514
 515 #define ICMP_HEADER_LEN 8
 516 struct icmp_header {
 517     uint8_t icmp_type;
 518     uint8_t icmp_code;
 519     ovs_be16 icmp_csum;
 520     union {
 521         struct {
 522             ovs_be16 id;
 523             ovs_be16 seq;
 524         } echo;
 525         struct {
 526             ovs_be16 empty;
 527             ovs_be16 mtu;
 528         } frag;
 529         ovs_16aligned_be32 gateway;
 530     } icmp_fields;
 531 };
 532 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
 533
 534 #define IGMP_HEADER_LEN 8
 535 struct igmp_header {
 536     uint8_t igmp_type;
 537     uint8_t igmp_code;
 538     ovs_be16 igmp_csum;
 539     ovs_16aligned_be32 group;
 540 };
 541 BUILD_ASSERT_DECL(IGMP_HEADER_LEN == sizeof(struct igmp_header));
 542
 543 #define IGMP_HOST_MEMBERSHIP_QUERY    0x11 /* From RFC1112 */
 544 #define IGMP_HOST_MEMBERSHIP_REPORT   0x12 /* Ditto */
 545 #define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x12 */
 546 #define IGMP_HOST_LEAVE_MESSAGE       0x17
 547 #define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x12 */
 548
 549 #define SCTP_HEADER_LEN 12
 550 struct sctp_header {
 551     ovs_be16 sctp_src;
 552     ovs_be16 sctp_dst;
 553     ovs_16aligned_be32 sctp_vtag;
 554     ovs_16aligned_be32 sctp_csum;
 555 };
 556 BUILD_ASSERT_DECL(SCTP_HEADER_LEN == sizeof(struct sctp_header));
 557
 558 #define UDP_HEADER_LEN 8
 559 struct udp_header {
 560     ovs_be16 udp_src;
 561     ovs_be16 udp_dst;
 562     ovs_be16 udp_len;
 563     ovs_be16 udp_csum;
 564 };
 565 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
 566
 567 #define TCP_FIN 0x001
 568 #define TCP_SYN 0x002
 569 #define TCP_RST 0x004
 570 #define TCP_PSH 0x008
 571 #define TCP_ACK 0x010
 572 #define TCP_URG 0x020
 573 #define TCP_ECE 0x040
 574 #define TCP_CWR 0x080
 575 #define TCP_NS  0x100
 576
 577 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
 578 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
 579 #define TCP_FLAGS_BE16(tcp_ctl) ((tcp_ctl) & htons(0x0fff))
 580 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
 581
 582 #define TCP_HEADER_LEN 20
 583 struct tcp_header {
 584     ovs_be16 tcp_src;
 585     ovs_be16 tcp_dst;
 586     ovs_16aligned_be32 tcp_seq;
 587     ovs_16aligned_be32 tcp_ack;
 588     ovs_be16 tcp_ctl;
 589     ovs_be16 tcp_winsz;
 590     ovs_be16 tcp_csum;
 591     ovs_be16 tcp_urg;
 592 };
 593 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
 594
 595 #define ARP_HRD_ETHERNET 1
 596 #define ARP_PRO_IP 0x0800
 597 #define ARP_OP_REQUEST 1
 598 #define ARP_OP_REPLY 2
 599 #define ARP_OP_RARP 3
 600
 601 #define ARP_ETH_HEADER_LEN 28
 602 struct arp_eth_header {
 603     /* Generic members. */
 604     ovs_be16 ar_hrd;           /* Hardware type. */
 605     ovs_be16 ar_pro;           /* Protocol type. */
 606     uint8_t ar_hln;            /* Hardware address length. */
 607     uint8_t ar_pln;            /* Protocol address length. */
 608     ovs_be16 ar_op;            /* Opcode. */
 609
 610     /* Ethernet+IPv4 specific members. */
 611     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
 612     ovs_16aligned_be32 ar_spa;           /* Sender protocol address. */
 613     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
 614     ovs_16aligned_be32 ar_tpa;           /* Target protocol address. */
 615 };
 616 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
 617
 618 /* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
 619  * most implementations, this one only requires 16-bit alignment. */
 620 union ovs_16aligned_in6_addr {
 621     ovs_be16 be16[8];
 622     ovs_16aligned_be32 be32[4];
 623 };
 624
 625 /* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
 626  * one only requires 16-bit alignment. */
 627 struct ovs_16aligned_ip6_hdr {
 628     union {
 629         struct ovs_16aligned_ip6_hdrctl {
 630             ovs_16aligned_be32 ip6_un1_flow;
 631             ovs_be16 ip6_un1_plen;
 632             uint8_t ip6_un1_nxt;
 633             uint8_t ip6_un1_hlim;
 634         } ip6_un1;
 635         uint8_t ip6_un2_vfc;
 636     } ip6_ctlun;
 637     union ovs_16aligned_in6_addr ip6_src;
 638     union ovs_16aligned_in6_addr ip6_dst;
 639 };
 640
 641 /* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
 642  * this one only requires 16-bit alignment. */
 643 struct ovs_16aligned_ip6_frag {
 644     uint8_t ip6f_nxt;
 645     uint8_t ip6f_reserved;
 646     ovs_be16 ip6f_offlg;
 647     ovs_16aligned_be32 ip6f_ident;
 648 };
 649
 650 #define ICMP6_HEADER_LEN 4
 651 struct icmp6_header {
 652     uint8_t icmp6_type;
 653     uint8_t icmp6_code;
 654     ovs_be16 icmp6_cksum;
 655 };
 656 BUILD_ASSERT_DECL(ICMP6_HEADER_LEN == sizeof(struct icmp6_header));
 657
 658 /* Neighbor Discovery option field.
 659  * ND options are always a multiple of 8 bytes in size. */
 660 #define ND_OPT_LEN 8
 661 struct ovs_nd_opt {
 662     uint8_t  nd_opt_type;      /* Values defined in icmp6.h */
 663     uint8_t  nd_opt_len;       /* in units of 8 octets (the size of this struct) */
 664     uint8_t  nd_opt_data[6];   /* Ethernet address in the case of SLL or TLL options */
 665 };
 666 BUILD_ASSERT_DECL(ND_OPT_LEN == sizeof(struct ovs_nd_opt));
 667
 668 /* Like struct nd_msg (from ndisc.h), but whereas that struct requires 32-bit
 669  * alignment, this one only requires 16-bit alignment. */
 670 #define ND_MSG_LEN 24
 671 struct ovs_nd_msg {
 672     struct icmp6_header icmph;
 673     ovs_16aligned_be32 rco_flags;
 674     union ovs_16aligned_in6_addr target;
 675     struct ovs_nd_opt options[0];
 676 };
 677 BUILD_ASSERT_DECL(ND_MSG_LEN == sizeof(struct ovs_nd_msg));
 678
 679 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
 680 #define IPV6_LABEL_MASK 0x000fffff
 681
 682 /* Example:
 683  *
 684  * char *string = "1 ::1 2";
 685  * char ipv6_s[IPV6_SCAN_LEN + 1];
 686  * struct in6_addr ipv6;
 687  *
 688  * if (ovs_scan(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b)
 689  *     && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
 690  *     ...
 691  * }
 692  */
 693 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
 694 #define IPV6_SCAN_LEN 46
 695
 696 extern const struct in6_addr in6addr_exact;
 697 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
 698                                  0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
 699
 700 static inline bool ipv6_addr_equals(const struct in6_addr *a,
 701                                     const struct in6_addr *b)
 702 {
 703 #ifdef IN6_ARE_ADDR_EQUAL
 704     return IN6_ARE_ADDR_EQUAL(a, b);
 705 #else
 706     return !memcmp(a, b, sizeof(*a));
 707 #endif
 708 }
 709
 710 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
 711     return ipv6_addr_equals(mask, &in6addr_any);
 712 }
 713
 714 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
 715     return ipv6_addr_equals(mask, &in6addr_exact);
 716 }
 717
 718 static inline bool dl_type_is_ip_any(ovs_be16 dl_type)
 719 {
 720     return dl_type == htons(ETH_TYPE_IP)
 721         || dl_type == htons(ETH_TYPE_IPV6);
 722 }
 723
 724 /* Tunnel header */
 725 #define GENEVE_CRIT_OPT_TYPE (1 << 7)
 726 struct geneve_opt {
 727     ovs_be16  opt_class;
 728     uint8_t   type;
 729 #ifdef WORDS_BIGENDIAN
 730     uint8_t   r1:1;
 731     uint8_t   r2:1;
 732     uint8_t   r3:1;
 733     uint8_t   length:5;
 734 #else
 735     uint8_t   length:5;
 736     uint8_t   r3:1;
 737     uint8_t   r2:1;
 738     uint8_t   r1:1;
 739 #endif
 740     /* Option data */
 741 };
 742
 743 struct genevehdr {
 744 #ifdef WORDS_BIGENDIAN
 745     uint8_t ver:2;
 746     uint8_t opt_len:6;
 747     uint8_t oam:1;
 748     uint8_t critical:1;
 749     uint8_t rsvd1:6;
 750 #else
 751     uint8_t opt_len:6;
 752     uint8_t ver:2;
 753     uint8_t rsvd1:6;
 754     uint8_t critical:1;
 755     uint8_t oam:1;
 756 #endif
 757     ovs_be16 proto_type;
 758     ovs_16aligned_be32 vni;
 759     struct geneve_opt options[];
 760 };
 761
 762 /* GRE protocol header */
 763 struct gre_base_hdr {
 764     ovs_be16 flags;
 765     ovs_be16 protocol;
 766 };
 767
 768 #define GRE_CSUM        0x8000
 769 #define GRE_ROUTING     0x4000
 770 #define GRE_KEY         0x2000
 771 #define GRE_SEQ         0x1000
 772 #define GRE_STRICT      0x0800
 773 #define GRE_REC         0x0700
 774 #define GRE_FLAGS       0x00F8
 775 #define GRE_VERSION     0x0007
 776
 777 /* VXLAN protocol header */
 778 struct vxlanhdr {
 779     ovs_16aligned_be32 vx_flags;
 780     ovs_16aligned_be32 vx_vni;
 781 };
 782
 783 #define VXLAN_FLAGS 0x08000000  /* struct vxlanhdr.vx_flags required value. */
 784
 785 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
 786 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
 787 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
 788                        const struct in6_addr *mask);
 789 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
 790                                  const struct in6_addr *mask);
 791 struct in6_addr ipv6_create_mask(int mask);
 792 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
 793 bool ipv6_is_cidr(const struct in6_addr *netmask);
 794
 795 void *eth_compose(struct dp_packet *, const uint8_t eth_dst[ETH_ADDR_LEN],
 796                   const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
 797                   size_t size);
 798 void *snap_compose(struct dp_packet *, const uint8_t eth_dst[ETH_ADDR_LEN],
 799                    const uint8_t eth_src[ETH_ADDR_LEN],
 800                    unsigned int oui, uint16_t snap_type, size_t size);
 801 void packet_set_ipv4(struct dp_packet *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
 802                      uint8_t ttl);
 803 void packet_set_ipv6(struct dp_packet *, uint8_t proto, const ovs_be32 src[4],
 804                      const ovs_be32 dst[4], uint8_t tc,
 805                      ovs_be32 fl, uint8_t hlmit);
 806 void packet_set_tcp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
 807 void packet_set_udp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
 808 void packet_set_sctp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
 809 void packet_set_nd(struct dp_packet *, const ovs_be32 target[4],
 810                    const uint8_t sll[6], const uint8_t tll[6]);
 811
 812 void packet_format_tcp_flags(struct ds *, uint16_t);
 813 const char *packet_tcp_flag_to_string(uint32_t flag);
 814 void compose_arp(struct dp_packet *b, const uint8_t eth_src[ETH_ADDR_LEN],
 815                  ovs_be32 ip_src, ovs_be32 ip_dst);
 816 uint32_t packet_csum_pseudoheader(const struct ip_header *);
 817
 818 #endif /* packets.h */