mirror of
https://github.com/openvswitch/ovs
synced 2025-10-13 14:07:02 +00:00
16c6d0c384
Since we know these bytes are always 0 in both structures, we can use faster functions that only work with full words. Signed-off-by: Ben Pfaff <blp@nicira.com>
187 lines
8.2 KiB
C
187 lines
8.2 KiB
C
/*
|
|
* Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
|
|
*
|
|
* 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 FLOW_H
|
|
#define FLOW_H 1
|
|
|
|
#include <sys/types.h>
|
|
#include <netinet/in.h>
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
#include "openflow/nicira-ext.h"
|
|
#include "openflow/openflow.h"
|
|
#include "hash.h"
|
|
#include "util.h"
|
|
|
|
struct dpif_flow_stats;
|
|
struct ds;
|
|
struct flow_wildcards;
|
|
struct ofpbuf;
|
|
|
|
/* This sequence number should be incremented whenever anything involving flows
|
|
* or the wildcarding of flows changes. This will cause build assertion
|
|
* failures in places which likely need to be updated. */
|
|
#define FLOW_WC_SEQ 17
|
|
|
|
#define FLOW_N_REGS 8
|
|
BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
|
|
|
|
/* Used for struct flow's dl_type member for frames that have no Ethernet
|
|
* type, that is, pure 802.2 frames. */
|
|
#define FLOW_DL_TYPE_NONE 0x5ff
|
|
|
|
/* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
|
|
#define FLOW_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
|
|
#define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
|
|
#define FLOW_NW_FRAG_MASK (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
|
|
|
|
BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
|
|
BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
|
|
|
|
struct flow {
|
|
ovs_be64 tun_id; /* Encapsulating tunnel ID. */
|
|
ovs_be64 metadata; /* OpenFlow Metadata. */
|
|
struct in6_addr ipv6_src; /* IPv6 source address. */
|
|
struct in6_addr ipv6_dst; /* IPv6 destination address. */
|
|
struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
|
|
uint32_t skb_priority; /* Packet priority for QoS. */
|
|
uint32_t regs[FLOW_N_REGS]; /* Registers. */
|
|
ovs_be32 nw_src; /* IPv4 source address. */
|
|
ovs_be32 nw_dst; /* IPv4 destination address. */
|
|
ovs_be32 ipv6_label; /* IPv6 flow label. */
|
|
uint16_t in_port; /* OpenFlow port number of input port. */
|
|
ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
|
|
ovs_be16 dl_type; /* Ethernet frame type. */
|
|
ovs_be16 tp_src; /* TCP/UDP source port. */
|
|
ovs_be16 tp_dst; /* TCP/UDP destination port. */
|
|
uint8_t dl_src[6]; /* Ethernet source address. */
|
|
uint8_t dl_dst[6]; /* Ethernet destination address. */
|
|
uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
|
|
uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */
|
|
uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
|
|
uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
|
|
uint8_t nw_ttl; /* IP TTL/Hop Limit. */
|
|
uint8_t nw_frag; /* FLOW_FRAG_* flags. */
|
|
uint8_t zeros[2]; /* Must be zero. */
|
|
};
|
|
BUILD_ASSERT_DECL(sizeof(struct flow) % 8 == 0);
|
|
|
|
/* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
|
|
BUILD_ASSERT_DECL(sizeof(struct flow) == 152 && FLOW_WC_SEQ == 17);
|
|
|
|
/* Represents the metadata fields of struct flow. */
|
|
struct flow_metadata {
|
|
ovs_be64 tun_id; /* Encapsulating tunnel ID. */
|
|
ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */
|
|
uint32_t regs[FLOW_N_REGS]; /* Registers. */
|
|
uint16_t in_port; /* OpenFlow port or zero. */
|
|
};
|
|
|
|
void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id,
|
|
uint16_t in_port, struct flow *);
|
|
void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
|
|
void flow_get_metadata(const struct flow *, struct flow_metadata *);
|
|
|
|
char *flow_to_string(const struct flow *);
|
|
void flow_format(struct ds *, const struct flow *);
|
|
void flow_print(FILE *, const struct flow *);
|
|
static inline int flow_compare_3way(const struct flow *, const struct flow *);
|
|
static inline bool flow_equal(const struct flow *, const struct flow *);
|
|
static inline size_t flow_hash(const struct flow *, uint32_t basis);
|
|
|
|
void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
|
|
void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
|
|
void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
|
|
|
|
void flow_compose(struct ofpbuf *, const struct flow *);
|
|
|
|
static inline int
|
|
flow_compare_3way(const struct flow *a, const struct flow *b)
|
|
{
|
|
return memcmp(a, b, sizeof *a);
|
|
}
|
|
|
|
static inline bool
|
|
flow_equal(const struct flow *a, const struct flow *b)
|
|
{
|
|
return !flow_compare_3way(a, b);
|
|
}
|
|
|
|
static inline size_t
|
|
flow_hash(const struct flow *flow, uint32_t basis)
|
|
{
|
|
return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
|
|
}
|
|
|
|
/* Information on wildcards for a flow, as a supplement to "struct flow". */
|
|
struct flow_wildcards {
|
|
ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */
|
|
ovs_be64 metadata_mask; /* 1-bit in each significant metadata bit. */
|
|
uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
|
|
ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */
|
|
ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */
|
|
struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */
|
|
struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */
|
|
struct in6_addr nd_target_mask; /* 1-bit in each significant
|
|
nd_target bit. */
|
|
ovs_be32 ipv6_label_mask; /* 1 bit in each significant ipv6_label bit. */
|
|
uint16_t in_port_mask; /* 1-bit in each significant in_port bit. */
|
|
ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */
|
|
ovs_be16 dl_type_mask; /* 1-bit in each significant dl_type bit. */
|
|
ovs_be16 tp_src_mask; /* 1-bit in each significant tp_src bit. */
|
|
ovs_be16 tp_dst_mask; /* 1-bit in each significant tp_dst bit. */
|
|
uint8_t nw_proto_mask; /* 1-bit in each significant nw_proto bit. */
|
|
uint8_t nw_frag_mask; /* 1-bit in each significant nw_frag bit. */
|
|
uint8_t dl_src_mask[6]; /* 1-bit in each significant dl_src bit. */
|
|
uint8_t dl_dst_mask[6]; /* 1-bit in each significant dl_dst bit. */
|
|
uint8_t arp_sha_mask[6]; /* 1-bit in each significant dl_dst bit. */
|
|
uint8_t arp_tha_mask[6]; /* 1-bit in each significant dl_dst bit. */
|
|
uint8_t nw_tos_mask; /* 1-bit in each significant nw_tos bit. */
|
|
uint8_t nw_ttl_mask; /* 1-bit in each significant nw_ttl bit. */
|
|
uint8_t zeros[6]; /* Padding field set to zero. */
|
|
};
|
|
BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) % 8 == 0);
|
|
|
|
/* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */
|
|
BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 152 && FLOW_WC_SEQ == 17);
|
|
|
|
void flow_wildcards_init_catchall(struct flow_wildcards *);
|
|
void flow_wildcards_init_exact(struct flow_wildcards *);
|
|
|
|
bool flow_wildcards_is_exact(const struct flow_wildcards *);
|
|
bool flow_wildcards_is_catchall(const struct flow_wildcards *);
|
|
|
|
void flow_wildcards_set_reg_mask(struct flow_wildcards *,
|
|
int idx, uint32_t mask);
|
|
|
|
void flow_wildcards_combine(struct flow_wildcards *dst,
|
|
const struct flow_wildcards *src1,
|
|
const struct flow_wildcards *src2);
|
|
bool flow_wildcards_has_extra(const struct flow_wildcards *,
|
|
const struct flow_wildcards *);
|
|
|
|
uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
|
|
bool flow_wildcards_equal(const struct flow_wildcards *,
|
|
const struct flow_wildcards *);
|
|
uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
|
|
|
|
uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
|
|
uint16_t basis);
|
|
const char *flow_hash_fields_to_str(enum nx_hash_fields);
|
|
bool flow_hash_fields_valid(enum nx_hash_fields);
|
|
|
|
#endif /* flow.h */
|