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