[ovs.git] / lib / packets.h

/*
 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef PACKETS_H
#define PACKETS_H 1

#include <inttypes.h>
#include <sys/types.h>
#include <netinet/in.h>
#include <stdint.h>
#include <string.h>
#include "compiler.h"
#include "openvswitch/types.h"
#include "random.h"
#include "util.h"

struct ofpbuf;
struct ds;

bool dpid_from_string(const char *s, uint64_t *dpidp);

#define ETH_ADDR_LEN           6

static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
    = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };

static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
    = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x01 };

static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
{
    return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
}

static inline bool eth_addr_is_multicast(const uint8_t ea[6])
{
    return ea[0] & 1;
}
static inline bool eth_addr_is_local(const uint8_t ea[6])
{
    /* Local if it is either a locally administered address or a Nicira random
     * address. */
    return !!(ea[0] & 2)
       || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && !!(ea[3] & 0x80));
}
static inline bool eth_addr_is_zero(const uint8_t ea[6])
{
    return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
}
static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
                                   const uint8_t b[ETH_ADDR_LEN])
{
    return !memcmp(a, b, ETH_ADDR_LEN);
}
static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
{
    return (((uint64_t) ea[0] << 40)
            | ((uint64_t) ea[1] << 32)
            | ((uint64_t) ea[2] << 24)
            | ((uint64_t) ea[3] << 16)
            | ((uint64_t) ea[4] << 8)
            | ea[5]);
}
static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
{
    ea[0] = x >> 40;
    ea[1] = x >> 32;
    ea[2] = x >> 24;
    ea[3] = x >> 16;
    ea[4] = x >> 8;
    ea[5] = x;
}
static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
{
    ea[0] &= ~1;                /* Unicast. */
    ea[0] |= 2;                 /* Private. */
}
static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
{
    random_bytes(ea, ETH_ADDR_LEN);
    eth_addr_mark_random(ea);
}
static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
{
    eth_addr_random(ea);

    /* Set the OUI to the Nicira one. */
    ea[0] = 0x00;
    ea[1] = 0x23;
    ea[2] = 0x20;

    /* Set the top bit to indicate random Nicira address. */
    ea[3] |= 0x80;
}
/* Returns true if 'ea' is a reserved multicast address, that a bridge must
 * never forward, false otherwise. */
static inline bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN])
{
    return (ea[0] == 0x01
            && ea[1] == 0x80
            && ea[2] == 0xc2
            && ea[3] == 0x00
            && ea[4] == 0x00
            && (ea[5] & 0xf0) == 0x00);
}

bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);

void compose_benign_packet(struct ofpbuf *, const char *tag,
                           uint16_t snap_type,
                           const uint8_t eth_src[ETH_ADDR_LEN]);

/* Example:
 *
 * uint8_t mac[ETH_ADDR_LEN];
 *    [...]
 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
 *
 */
#define ETH_ADDR_FMT                                                    \
    "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
#define ETH_ADDR_ARGS(ea)                                   \
    (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]

/* Example:
 *
 * char *string = "1 00:11:22:33:44:55 2";
 * uint8_t mac[ETH_ADDR_LEN];
 * int a, b;
 *
 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
 *     &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
 *     ...
 * }
 */
#define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
#define ETH_ADDR_SCAN_ARGS(ea) \
        &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
#define ETH_ADDR_SCAN_COUNT 6

#define ETH_TYPE_IP            0x0800
#define ETH_TYPE_ARP           0x0806
#define ETH_TYPE_VLAN          0x8100
#define ETH_TYPE_IPV6          0x86dd
#define ETH_TYPE_CFM           0x8902

/* Minimum value for an Ethernet type.  Values below this are IEEE 802.2 frame
 * lengths. */
#define ETH_TYPE_MIN           0x600

#define ETH_HEADER_LEN 14
#define ETH_PAYLOAD_MIN 46
#define ETH_PAYLOAD_MAX 1500
#define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
#define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
#define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
struct eth_header {
    uint8_t eth_dst[ETH_ADDR_LEN];
    uint8_t eth_src[ETH_ADDR_LEN];
    uint16_t eth_type;
} __attribute__((packed));
BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));

#define LLC_DSAP_SNAP 0xaa
#define LLC_SSAP_SNAP 0xaa
#define LLC_CNTL_SNAP 3

#define LLC_HEADER_LEN 3
struct llc_header {
    uint8_t llc_dsap;
    uint8_t llc_ssap;
    uint8_t llc_cntl;
} __attribute__((packed));
BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));

#define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
                                    sizeof(SNAP_ORG_ETHERNET) == 3. */
#define SNAP_HEADER_LEN 5
struct snap_header {
    uint8_t snap_org[3];
    uint16_t snap_type;
} __attribute__((packed));
BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));

#define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
struct llc_snap_header {
    struct llc_header llc;
    struct snap_header snap;
} __attribute__((packed));
BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));

#define VLAN_VID_MASK 0x0fff
#define VLAN_VID_SHIFT 0

#define VLAN_PCP_MASK 0xe000
#define VLAN_PCP_SHIFT 13

#define VLAN_CFI 0x1000

/* Given the vlan_tci field from an 802.1Q header, in network byte order,
 * returns the VLAN ID in host byte order. */
static inline uint16_t
vlan_tci_to_vid(uint16_t vlan_tci)
{
    return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
}

/* Given the vlan_tci field from an 802.1Q header, in network byte order,
 * returns the priority code point (PCP) in host byte order. */
static inline int
vlan_tci_to_pcp(uint16_t vlan_tci)
{
    return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
}

#define VLAN_HEADER_LEN 4
struct vlan_header {
    uint16_t vlan_tci;          /* Lowest 12 bits are VLAN ID. */
    uint16_t vlan_next_type;
};
BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));

#define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
struct vlan_eth_header {
    uint8_t veth_dst[ETH_ADDR_LEN];
    uint8_t veth_src[ETH_ADDR_LEN];
    uint16_t veth_type;         /* Always htons(ETH_TYPE_VLAN). */
    uint16_t veth_tci;          /* Lowest 12 bits are VLAN ID. */
    uint16_t veth_next_type;
} __attribute__((packed));
BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));

/* A 'ccm' represents a Continuity Check Message from the 802.1ag specification.
 * Continuity Check Messages are broadcast periodically so that hosts can
 * determine who they have connectivity to. */
#define CCM_LEN 74
#define CCM_MAID_LEN 48
struct ccm {
    uint8_t  mdlevel_version; /* MD Level and Version */
    uint8_t  opcode;
    uint8_t  flags;
    uint8_t  tlv_offset;
    uint32_t seq;
    uint16_t mpid;
    uint8_t  maid[CCM_MAID_LEN];
    uint8_t  zero[16]; /* Defined by ITU-T Y.1731 should be zero */
} __attribute__((packed));
BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));

/* The "(void) (ip)[0]" below has no effect on the value, since it's the first
 * argument of a comma expression, but it makes sure that 'ip' is a pointer.
 * This is useful since a common mistake is to pass an integer instead of a
 * pointer to IP_ARGS. */
#define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
#define IP_ARGS(ip)                             \
        ((void) (ip)[0], ((uint8_t *) ip)[0]),  \
        ((uint8_t *) ip)[1],                    \
        ((uint8_t *) ip)[2],                    \
        ((uint8_t *) ip)[3]

/* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 * high-order 1-bits and 32-N low-order 0-bits. */
static inline bool
ip_is_cidr(ovs_be32 netmask)
{
    uint32_t x = ~ntohl(netmask);
    return !(x & (x + 1));
}

#define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
#define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
#define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))

/* TOS fields. */
#define IP_ECN_MASK 0x03
#define IP_DSCP_MASK 0xfc

#define IP_VERSION 4

#define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
#define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
#define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
#define IP_IS_FRAGMENT(ip_frag_off) \
        ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))

#define IP_HEADER_LEN 20
struct ip_header {
    uint8_t ip_ihl_ver;
    uint8_t ip_tos;
    uint16_t ip_tot_len;
    uint16_t ip_id;
    uint16_t ip_frag_off;
    uint8_t ip_ttl;
    uint8_t ip_proto;
    uint16_t ip_csum;
    uint32_t ip_src;
    uint32_t ip_dst;
};
BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));

#define ICMP_HEADER_LEN 4
struct icmp_header {
    uint8_t icmp_type;
    uint8_t icmp_code;
    uint16_t icmp_csum;
};
BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));

#define UDP_HEADER_LEN 8
struct udp_header {
    uint16_t udp_src;
    uint16_t udp_dst;
    uint16_t udp_len;
    uint16_t udp_csum;
};
BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));

#define TCP_FIN 0x01
#define TCP_SYN 0x02
#define TCP_RST 0x04
#define TCP_PSH 0x08
#define TCP_ACK 0x10
#define TCP_URG 0x20

#define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
#define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)

#define TCP_HEADER_LEN 20
struct tcp_header {
    uint16_t tcp_src;
    uint16_t tcp_dst;
    uint32_t tcp_seq;
    uint32_t tcp_ack;
    uint16_t tcp_ctl;
    uint16_t tcp_winsz;
    uint16_t tcp_csum;
    uint16_t tcp_urg;
};
BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));

#define ARP_HRD_ETHERNET 1
#define ARP_PRO_IP 0x0800
#define ARP_OP_REQUEST 1
#define ARP_OP_REPLY 2

#define ARP_ETH_HEADER_LEN 28
struct arp_eth_header {
    /* Generic members. */
    uint16_t ar_hrd;           /* Hardware type. */
    uint16_t ar_pro;           /* Protocol type. */
    uint8_t ar_hln;            /* Hardware address length. */
    uint8_t ar_pln;            /* Protocol address length. */
    uint16_t ar_op;            /* Opcode. */

    /* Ethernet+IPv4 specific members. */
    uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
    uint32_t ar_spa;           /* Sender protocol address. */
    uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
    uint32_t ar_tpa;           /* Target protocol address. */
} __attribute__((packed));
BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));

extern const struct in6_addr in6addr_exact;
#define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
                                 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }

static inline bool ipv6_addr_equals(const struct in6_addr *a,
                                    const struct in6_addr *b)
{
#ifdef IN6_ARE_ADDR_EQUAL
    return IN6_ARE_ADDR_EQUAL(a, b);
#else
    return !memcmp(a, b, sizeof(*a));
#endif
}

static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
    return ipv6_addr_equals(mask, &in6addr_any);
}

static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
    return ipv6_addr_equals(mask, &in6addr_exact);
}

void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
                                 const struct in6_addr *mask);
struct in6_addr ipv6_create_mask(int mask);
int ipv6_count_cidr_bits(const struct in6_addr *netmask);
bool ipv6_is_cidr(const struct in6_addr *netmask);

#endif /* packets.h */
Commit	Line	Data
064af421	1	/*
67a4917b	2	* Copyright (c) 2008, 2009, 2010 Nicira Networks.
064af421	3	*
a14bc59f BP	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:
064af421	7	*
a14bc59f BP	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.
064af421	15	*/
b9e8b45a	16
064af421 BP	17	#ifndef PACKETS_H
	18	#define PACKETS_H 1
	19
ab9c78ff	20	#include <inttypes.h>
26233bb4 BP	21	#include <sys/types.h>
26233bb4 BP	22	#include <netinet/in.h>
064af421 BP	23	#include <stdint.h>
	24	#include <string.h>
	25	#include "compiler.h"
0596e897	26	#include "openvswitch/types.h"
064af421 BP	27	#include "random.h"
	28	#include "util.h"
	29
b9e8b45a	30	struct ofpbuf;
d31f1109	31	struct ds;
b9e8b45a	32
76343538 BP	33	bool dpid_from_string(const char s, uint64_t dpidp);
76343538 BP	34
064af421 BP	35	#define ETH_ADDR_LEN 6
064af421 BP	36
67a4917b	37	static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
064af421 BP	38	= { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
064af421 BP	39
ba186119 BP	40	static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
	41	= { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x01 };
	42
064af421 BP	43	static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
	44	{
	45	return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
	46	}
	47
064af421 BP	48	static inline bool eth_addr_is_multicast(const uint8_t ea[6])
	49	{
	50	return ea[0] & 1;
	51	}
d295e8e9	52	static inline bool eth_addr_is_local(const uint8_t ea[6])
064af421	53	{
70150daf JG	54	/* Local if it is either a locally administered address or a Nicira random
	55	* address. */
	56	return !!(ea[0] & 2)
	57	\|\| (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && !!(ea[3] & 0x80));
064af421	58	}
d295e8e9	59	static inline bool eth_addr_is_zero(const uint8_t ea[6])
064af421 BP	60	{
	61	return !(ea[0] \| ea[1] \| ea[2] \| ea[3] \| ea[4] \| ea[5]);
	62	}
	63	static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
d295e8e9	64	const uint8_t b[ETH_ADDR_LEN])
064af421 BP	65	{
	66	return !memcmp(a, b, ETH_ADDR_LEN);
	67	}
	68	static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
	69	{
	70	return (((uint64_t) ea[0] << 40)
	71	\| ((uint64_t) ea[1] << 32)
	72	\| ((uint64_t) ea[2] << 24)
	73	\| ((uint64_t) ea[3] << 16)
	74	\| ((uint64_t) ea[4] << 8)
	75	\| ea[5]);
	76	}
	77	static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
	78	{
	79	ea[0] = x >> 40;
	80	ea[1] = x >> 32;
	81	ea[2] = x >> 24;
	82	ea[3] = x >> 16;
	83	ea[4] = x >> 8;
	84	ea[5] = x;
	85	}
	86	static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
	87	{
	88	ea[0] &= ~1; /* Unicast. */
	89	ea[0] \|= 2; /* Private. */
	90	}
	91	static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
	92	{
	93	random_bytes(ea, ETH_ADDR_LEN);
	94	eth_addr_mark_random(ea);
	95	}
70150daf JG	96	static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
	97	{
	98	eth_addr_random(ea);
	99
	100	/* Set the OUI to the Nicira one. */
	101	ea[0] = 0x00;
	102	ea[1] = 0x23;
	103	ea[2] = 0x20;
	104
	105	/* Set the top bit to indicate random Nicira address. */
	106	ea[3] \|= 0x80;
	107	}
064af421 BP	108	/* Returns true if 'ea' is a reserved multicast address, that a bridge must
	109	* never forward, false otherwise. */
	110	static inline bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN])
	111	{
	112	return (ea[0] == 0x01
	113	&& ea[1] == 0x80
	114	&& ea[2] == 0xc2
	115	&& ea[3] == 0x00
	116	&& ea[4] == 0x00
	117	&& (ea[5] & 0xf0) == 0x00);
	118	}
	119
76343538 BP	120	bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
76343538 BP	121
b9e8b45a BP	122	void compose_benign_packet(struct ofpbuf , const char tag,
	123	uint16_t snap_type,
	124	const uint8_t eth_src[ETH_ADDR_LEN]);
	125
eaa71334 BP	126	/* Example:
	127	*
	128	* uint8_t mac[ETH_ADDR_LEN];
	129	* [...]
	130	* printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
	131	*
	132	*/
064af421 BP	133	#define ETH_ADDR_FMT \
	134	"%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
	135	#define ETH_ADDR_ARGS(ea) \
	136	(ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
	137
eaa71334 BP	138	/* Example:
	139	*
	140	* char *string = "1 00:11:22:33:44:55 2";
	141	* uint8_t mac[ETH_ADDR_LEN];
	142	* int a, b;
	143	*
	144	* if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
	145	* &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
	146	* ...
	147	* }
	148	*/
	149	#define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
	150	#define ETH_ADDR_SCAN_ARGS(ea) \
	151	&(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
	152	#define ETH_ADDR_SCAN_COUNT 6
	153
064af421 BP	154	#define ETH_TYPE_IP 0x0800
	155	#define ETH_TYPE_ARP 0x0806
	156	#define ETH_TYPE_VLAN 0x8100
d31f1109	157	#define ETH_TYPE_IPV6 0x86dd
b31bcf60	158	#define ETH_TYPE_CFM 0x8902
064af421	159
36956a7d BP	160	/* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
	161	* lengths. */
	162	#define ETH_TYPE_MIN 0x600
	163
064af421 BP	164	#define ETH_HEADER_LEN 14
	165	#define ETH_PAYLOAD_MIN 46
	166	#define ETH_PAYLOAD_MAX 1500
	167	#define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
	168	#define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
	169	#define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
	170	struct eth_header {
	171	uint8_t eth_dst[ETH_ADDR_LEN];
	172	uint8_t eth_src[ETH_ADDR_LEN];
	173	uint16_t eth_type;
	174	} __attribute__((packed));
	175	BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
	176
	177	#define LLC_DSAP_SNAP 0xaa
	178	#define LLC_SSAP_SNAP 0xaa
	179	#define LLC_CNTL_SNAP 3
	180
	181	#define LLC_HEADER_LEN 3
	182	struct llc_header {
	183	uint8_t llc_dsap;
	184	uint8_t llc_ssap;
	185	uint8_t llc_cntl;
	186	} __attribute__((packed));
	187	BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
	188
	189	#define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
	190	sizeof(SNAP_ORG_ETHERNET) == 3. */
	191	#define SNAP_HEADER_LEN 5
	192	struct snap_header {
	193	uint8_t snap_org[3];
	194	uint16_t snap_type;
	195	} __attribute__((packed));
	196	BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
	197
	198	#define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
	199	struct llc_snap_header {
	200	struct llc_header llc;
	201	struct snap_header snap;
	202	} __attribute__((packed));
	203	BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
	204
	205	#define VLAN_VID_MASK 0x0fff
33ce24ed BP	206	#define VLAN_VID_SHIFT 0
33ce24ed BP	207
064af421	208	#define VLAN_PCP_MASK 0xe000
33ce24ed	209	#define VLAN_PCP_SHIFT 13
064af421	210
26233bb4 BP	211	#define VLAN_CFI 0x1000
	212
	213	/* Given the vlan_tci field from an 802.1Q header, in network byte order,
	214	* returns the VLAN ID in host byte order. */
	215	static inline uint16_t
	216	vlan_tci_to_vid(uint16_t vlan_tci)
	217	{
	218	return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
	219	}
	220
	221	/* Given the vlan_tci field from an 802.1Q header, in network byte order,
	222	* returns the priority code point (PCP) in host byte order. */
	223	static inline int
	224	vlan_tci_to_pcp(uint16_t vlan_tci)
	225	{
	226	return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
	227	}
	228
064af421 BP	229	#define VLAN_HEADER_LEN 4
	230	struct vlan_header {
	231	uint16_t vlan_tci; /* Lowest 12 bits are VLAN ID. */
	232	uint16_t vlan_next_type;
	233	};
	234	BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
	235
	236	#define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
	237	struct vlan_eth_header {
	238	uint8_t veth_dst[ETH_ADDR_LEN];
	239	uint8_t veth_src[ETH_ADDR_LEN];
	240	uint16_t veth_type; /* Always htons(ETH_TYPE_VLAN). */
	241	uint16_t veth_tci; /* Lowest 12 bits are VLAN ID. */
	242	uint16_t veth_next_type;
	243	} __attribute__((packed));
	244	BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
	245
b31bcf60 EJ	246	/* A 'ccm' represents a Continuity Check Message from the 802.1ag specification.
	247	* Continuity Check Messages are broadcast periodically so that hosts can
	248	* determine who they have connectivity to. */
	249	#define CCM_LEN 74
	250	#define CCM_MAID_LEN 48
	251	struct ccm {
	252	uint8_t mdlevel_version; /* MD Level and Version */
	253	uint8_t opcode;
	254	uint8_t flags;
	255	uint8_t tlv_offset;
	256	uint32_t seq;
	257	uint16_t mpid;
	258	uint8_t maid[CCM_MAID_LEN];
	259	uint8_t zero[16]; /* Defined by ITU-T Y.1731 should be zero */
	260	} __attribute__((packed));
	261	BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
	262
064af421 BP	263	/* The "(void) (ip)[0]" below has no effect on the value, since it's the first
	264	* argument of a comma expression, but it makes sure that 'ip' is a pointer.
	265	* This is useful since a common mistake is to pass an integer instead of a
	266	* pointer to IP_ARGS. */
	267	#define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
	268	#define IP_ARGS(ip) \
	269	((void) (ip)[0], ((uint8_t *) ip)[0]), \
	270	((uint8_t *) ip)[1], \
	271	((uint8_t *) ip)[2], \
	272	((uint8_t *) ip)[3]
	273
0596e897 BP	274	/* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
	275	* high-order 1-bits and 32-N low-order 0-bits. */
	276	static inline bool
	277	ip_is_cidr(ovs_be32 netmask)
	278	{
	279	uint32_t x = ~ntohl(netmask);
	280	return !(x & (x + 1));
	281	}
	282
064af421 BP	283	#define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
	284	#define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
	285	#define IP_IHL_VER(ihl, ver) (((ver) << 4) \| (ihl))
	286
f1193301 BP	287	/* TOS fields. */
	288	#define IP_ECN_MASK 0x03
	289	#define IP_DSCP_MASK 0xfc
	290
064af421 BP	291	#define IP_VERSION 4
	292
	293	#define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
	294	#define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
	295	#define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
	296	#define IP_IS_FRAGMENT(ip_frag_off) \
	297	((ip_frag_off) & htons(IP_MORE_FRAGMENTS \| IP_FRAG_OFF_MASK))
	298
	299	#define IP_HEADER_LEN 20
	300	struct ip_header {
	301	uint8_t ip_ihl_ver;
	302	uint8_t ip_tos;
	303	uint16_t ip_tot_len;
	304	uint16_t ip_id;
	305	uint16_t ip_frag_off;
	306	uint8_t ip_ttl;
	307	uint8_t ip_proto;
	308	uint16_t ip_csum;
	309	uint32_t ip_src;
	310	uint32_t ip_dst;
	311	};
	312	BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
	313
	314	#define ICMP_HEADER_LEN 4
	315	struct icmp_header {
	316	uint8_t icmp_type;
	317	uint8_t icmp_code;
	318	uint16_t icmp_csum;
	319	};
	320	BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
	321
	322	#define UDP_HEADER_LEN 8
	323	struct udp_header {
	324	uint16_t udp_src;
	325	uint16_t udp_dst;
	326	uint16_t udp_len;
	327	uint16_t udp_csum;
	328	};
	329	BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
	330
	331	#define TCP_FIN 0x01
	332	#define TCP_SYN 0x02
	333	#define TCP_RST 0x04
	334	#define TCP_PSH 0x08
	335	#define TCP_ACK 0x10
	336	#define TCP_URG 0x20
	337
	338	#define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
	339	#define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)
	340
	341	#define TCP_HEADER_LEN 20
	342	struct tcp_header {
	343	uint16_t tcp_src;
	344	uint16_t tcp_dst;
	345	uint32_t tcp_seq;
	346	uint32_t tcp_ack;
	347	uint16_t tcp_ctl;
	348	uint16_t tcp_winsz;
	349	uint16_t tcp_csum;
	350	uint16_t tcp_urg;
	351	};
	352	BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
	353
	354	#define ARP_HRD_ETHERNET 1
355	#define ARP_PRO_IP 0x0800
356	#define ARP_OP_REQUEST 1
357	#define ARP_OP_REPLY 2
358
359	#define ARP_ETH_HEADER_LEN 28
360	struct arp_eth_header {
361	/* Generic members. */
362	uint16_t ar_hrd; /* Hardware type. */
363	uint16_t ar_pro; /* Protocol type. */
364	uint8_t ar_hln; /* Hardware address length. */
365	uint8_t ar_pln; /* Protocol address length. */
366	uint16_t ar_op; /* Opcode. */
367
368	/* Ethernet+IPv4 specific members. */
369	uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
370	uint32_t ar_spa; /* Sender protocol address. */
371	uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
372	uint32_t ar_tpa; /* Target protocol address. */
373	} __attribute__((packed));
374	BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
375
d31f1109 JP	376	extern const struct in6_addr in6addr_exact;
	377	#define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
	378	0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
	379
	380	static inline bool ipv6_addr_equals(const struct in6_addr *a,
	381	const struct in6_addr *b)
	382	{
	383	#ifdef IN6_ARE_ADDR_EQUAL
	384	return IN6_ARE_ADDR_EQUAL(a, b);
	385	#else
	386	return !memcmp(a, b, sizeof(*a));
	387	#endif
	388	}
	389
	390	static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
	391	return ipv6_addr_equals(mask, &in6addr_any);
	392	}
	393
	394	static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
	395	return ipv6_addr_equals(mask, &in6addr_exact);
	396	}
	397
	398	void format_ipv6_addr(char addr_str, const struct in6_addr addr);
	399	void print_ipv6_addr(struct ds string, const struct in6_addr addr);
	400	struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
	401	const struct in6_addr *mask);
	402	struct in6_addr ipv6_create_mask(int mask);
	403	int ipv6_count_cidr_bits(const struct in6_addr *netmask);
	404	bool ipv6_is_cidr(const struct in6_addr *netmask);
	405
064af421	406	#endif /* packets.h */