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