[mirror_ovs.git] / lib / match.h

/*
 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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 MATCH_H
#define MATCH_H 1

#include "flow.h"
#include "packets.h"

struct ds;

/* A flow classification match.
 *
 * Use one of the match_*() functions to initialize a "struct match".
 *
 * The match_*() functions below maintain the following important invariant.
 * If a bit or a field is wildcarded in 'wc', then the corresponding bit or
 * field in 'flow' is set to all-0-bits.  (The match_zero_wildcarded_fields()
 * function can be used to restore this invariant after adding wildcards.) */
struct match {
    struct flow flow;
    struct flow_wildcards wc;
};

void match_init(struct match *,
                const struct flow *, const struct flow_wildcards *);
void match_wc_init(struct match *match, const struct flow *flow);
void match_init_catchall(struct match *);

void match_zero_wildcarded_fields(struct match *);

void match_set_dp_hash(struct match *, uint32_t value);
void match_set_dp_hash_masked(struct match *, uint32_t value, uint32_t mask);

void match_set_recirc_id(struct match *, uint32_t value);
void match_set_recirc_id_masked(struct match *, uint32_t value, uint32_t mask);

void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
void match_set_reg_masked(struct match *, unsigned int reg_idx,
                          uint32_t value, uint32_t mask);
void match_set_xreg(struct match *, unsigned int xreg_idx, uint64_t value);
void match_set_xreg_masked(struct match *, unsigned int xreg_idx,
                           uint64_t value, uint64_t mask);
void match_set_metadata(struct match *, ovs_be64 metadata);
void match_set_metadata_masked(struct match *,
                               ovs_be64 metadata, ovs_be64 mask);
void match_set_tun_id(struct match *, ovs_be64 tun_id);
void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
void match_set_tun_src(struct match *match, ovs_be32 src);
void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask);
void match_set_tun_dst(struct match *match, ovs_be32 dst);
void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask);
void match_set_tun_ttl(struct match *match, uint8_t ttl);
void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask);
void match_set_tun_tos(struct match *match, uint8_t tos);
void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask);
void match_set_tun_flags(struct match *match, uint16_t flags);
void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask);
void match_set_in_port(struct match *, ofp_port_t ofp_port);
void match_set_pkt_mark(struct match *, uint32_t pkt_mark);
void match_set_pkt_mark_masked(struct match *, uint32_t pkt_mark, uint32_t mask);
void match_set_skb_priority(struct match *, uint32_t skb_priority);
void match_set_dl_type(struct match *, ovs_be16);
void match_set_dl_src(struct match *, const uint8_t[ETH_ADDR_LEN]);
void match_set_dl_src_masked(struct match *, const uint8_t dl_src[ETH_ADDR_LEN],
                             const uint8_t mask[ETH_ADDR_LEN]);
void match_set_dl_dst(struct match *, const uint8_t[ETH_ADDR_LEN]);
void match_set_dl_dst_masked(struct match *, const uint8_t dl_dst[ETH_ADDR_LEN],
                             const uint8_t mask[ETH_ADDR_LEN]);
void match_set_dl_tci(struct match *, ovs_be16 tci);
void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
void match_set_any_vid(struct match *);
void match_set_dl_vlan(struct match *, ovs_be16);
void match_set_vlan_vid(struct match *, ovs_be16);
void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
void match_set_any_pcp(struct match *);
void match_set_dl_vlan_pcp(struct match *, uint8_t);
void match_set_any_mpls_lse(struct match *, int idx);
void match_set_mpls_lse(struct match *, int idx, ovs_be32);
void match_set_any_mpls_label(struct match *, int idx);
void match_set_mpls_label(struct match *, int idx, ovs_be32);
void match_set_any_mpls_tc(struct match *, int idx);
void match_set_mpls_tc(struct match *, int idx, uint8_t);
void match_set_any_mpls_bos(struct match *, int idx);
void match_set_mpls_bos(struct match *, int idx, uint8_t);
void match_set_tp_src(struct match *, ovs_be16);
void match_set_mpls_lse(struct match *, int idx, ovs_be32 lse);
void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
void match_set_tp_dst(struct match *, ovs_be16);
void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
void match_set_tcp_flags(struct match *, ovs_be16);
void match_set_tcp_flags_masked(struct match *, ovs_be16 flags, ovs_be16 mask);
void match_set_nw_proto(struct match *, uint8_t);
void match_set_nw_src(struct match *, ovs_be32);
void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
void match_set_nw_dst(struct match *, ovs_be32);
void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
void match_set_nw_dscp(struct match *, uint8_t);
void match_set_nw_ecn(struct match *, uint8_t);
void match_set_nw_ttl(struct match *, uint8_t);
void match_set_nw_frag(struct match *, uint8_t nw_frag);
void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
void match_set_icmp_type(struct match *, uint8_t);
void match_set_icmp_code(struct match *, uint8_t);
void match_set_arp_sha(struct match *, const uint8_t[ETH_ADDR_LEN]);
void match_set_arp_sha_masked(struct match *,
                              const uint8_t arp_sha[ETH_ADDR_LEN],
                              const uint8_t mask[ETH_ADDR_LEN]);
void match_set_arp_tha(struct match *, const uint8_t[ETH_ADDR_LEN]);
void match_set_arp_tha_masked(struct match *,
                              const uint8_t arp_tha[ETH_ADDR_LEN],
                              const uint8_t mask[ETH_ADDR_LEN]);
void match_set_ipv6_src(struct match *, const struct in6_addr *);
void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
                               const struct in6_addr *);
void match_set_ipv6_dst(struct match *, const struct in6_addr *);
void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
                               const struct in6_addr *);
void match_set_ipv6_label(struct match *, ovs_be32);
void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
void match_set_nd_target(struct match *, const struct in6_addr *);
void match_set_nd_target_masked(struct match *, const struct in6_addr *,
                                const struct in6_addr *);

bool match_equal(const struct match *, const struct match *);
uint32_t match_hash(const struct match *, uint32_t basis);

void match_init_hidden_fields(struct match *);
bool match_has_default_hidden_fields(const struct match *);

void match_format(const struct match *, struct ds *, int priority);
char *match_to_string(const struct match *, int priority);
void match_print(const struct match *);
\f
/* Compressed match. */

/* A sparse representation of a "struct match".
 *
 * There are two invariants:
 *
 *   - The same invariant as "struct match", that is, a 1-bit in the 'flow'
 *     must correspond to a 1-bit in 'mask'.
 *
 *   - 'flow' and 'mask' have the same 'map'.  This implies that 'flow' and
 *     'mask' have the same part of "struct flow" at the same offset into
 *     'values', which makes minimatch_matches_flow() faster.
 */
struct minimatch {
    struct miniflow flow;
    struct minimask mask;
};

void minimatch_init(struct minimatch *, const struct match *);
void minimatch_clone(struct minimatch *, const struct minimatch *);
void minimatch_move(struct minimatch *dst, struct minimatch *src);
void minimatch_destroy(struct minimatch *);

void minimatch_expand(const struct minimatch *, struct match *);

bool minimatch_equal(const struct minimatch *a, const struct minimatch *b);

bool minimatch_matches_flow(const struct minimatch *, const struct flow *);

void minimatch_format(const struct minimatch *, struct ds *, int priority);
char *minimatch_to_string(const struct minimatch *, int priority);

#endif /* match.h */
Commit	Line	Data
81a76618	1	/*
79fe0f46	2	* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
81a76618 BP	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 MATCH_H
	18	#define MATCH_H 1
	19
	20	#include "flow.h"
3bd0fd39	21	#include "packets.h"
81a76618	22
5cb7a798 BP	23	struct ds;
5cb7a798 BP	24
81a76618 BP	25	/* A flow classification match.
	26	*
	27	* Use one of the match_*() functions to initialize a "struct match".
	28	*
	29	* The match_*() functions below maintain the following important invariant.
	30	* If a bit or a field is wildcarded in 'wc', then the corresponding bit or
	31	* field in 'flow' is set to all-0-bits. (The match_zero_wildcarded_fields()
	32	* function can be used to restore this invariant after adding wildcards.) */
	33	struct match {
	34	struct flow flow;
	35	struct flow_wildcards wc;
	36	};
	37
	38	void match_init(struct match *,
	39	const struct flow , const struct flow_wildcards );
aa6c9932	40	void match_wc_init(struct match match, const struct flow flow);
81a76618	41	void match_init_catchall(struct match *);
81a76618 BP	42
	43	void match_zero_wildcarded_fields(struct match *);
	44
a79f29f2 AZ	45	void match_set_dp_hash(struct match *, uint32_t value);
	46	void match_set_dp_hash_masked(struct match *, uint32_t value, uint32_t mask);
	47
	48	void match_set_recirc_id(struct match *, uint32_t value);
	49	void match_set_recirc_id_masked(struct match *, uint32_t value, uint32_t mask);
	50
81a76618 BP	51	void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
	52	void match_set_reg_masked(struct match *, unsigned int reg_idx,
	53	uint32_t value, uint32_t mask);
79fe0f46 BP	54	void match_set_xreg(struct match *, unsigned int xreg_idx, uint64_t value);
	55	void match_set_xreg_masked(struct match *, unsigned int xreg_idx,
	56	uint64_t value, uint64_t mask);
81a76618 BP	57	void match_set_metadata(struct match *, ovs_be64 metadata);
	58	void match_set_metadata_masked(struct match *,
	59	ovs_be64 metadata, ovs_be64 mask);
	60	void match_set_tun_id(struct match *, ovs_be64 tun_id);
	61	void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
4fe3445a PS	62	void match_set_tun_src(struct match *match, ovs_be32 src);
	63	void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask);
	64	void match_set_tun_dst(struct match *match, ovs_be32 dst);
	65	void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask);
	66	void match_set_tun_ttl(struct match *match, uint8_t ttl);
	67	void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask);
	68	void match_set_tun_tos(struct match *match, uint8_t tos);
	69	void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask);
	70	void match_set_tun_flags(struct match *match, uint16_t flags);
	71	void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask);
4e022ec0	72	void match_set_in_port(struct match *, ofp_port_t ofp_port);
1362e248	73	void match_set_pkt_mark(struct match *, uint32_t pkt_mark);
ac923e91	74	void match_set_pkt_mark_masked(struct match *, uint32_t pkt_mark, uint32_t mask);
1b567fb9	75	void match_set_skb_priority(struct match *, uint32_t skb_priority);
81a76618	76	void match_set_dl_type(struct match *, ovs_be16);
3bd0fd39 WSH	77	void match_set_dl_src(struct match *, const uint8_t[ETH_ADDR_LEN]);
	78	void match_set_dl_src_masked(struct match *, const uint8_t dl_src[ETH_ADDR_LEN],
	79	const uint8_t mask[ETH_ADDR_LEN]);
	80	void match_set_dl_dst(struct match *, const uint8_t[ETH_ADDR_LEN]);
	81	void match_set_dl_dst_masked(struct match *, const uint8_t dl_dst[ETH_ADDR_LEN],
	82	const uint8_t mask[ETH_ADDR_LEN]);
81a76618 BP	83	void match_set_dl_tci(struct match *, ovs_be16 tci);
	84	void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
	85	void match_set_any_vid(struct match *);
	86	void match_set_dl_vlan(struct match *, ovs_be16);
	87	void match_set_vlan_vid(struct match *, ovs_be16);
	88	void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
	89	void match_set_any_pcp(struct match *);
	90	void match_set_dl_vlan_pcp(struct match *, uint8_t);
8bfd0fda BP	91	void match_set_any_mpls_lse(struct match *, int idx);
	92	void match_set_mpls_lse(struct match *, int idx, ovs_be32);
	93	void match_set_any_mpls_label(struct match *, int idx);
	94	void match_set_mpls_label(struct match *, int idx, ovs_be32);
	95	void match_set_any_mpls_tc(struct match *, int idx);
	96	void match_set_mpls_tc(struct match *, int idx, uint8_t);
	97	void match_set_any_mpls_bos(struct match *, int idx);
	98	void match_set_mpls_bos(struct match *, int idx, uint8_t);
81a76618	99	void match_set_tp_src(struct match *, ovs_be16);
8bfd0fda	100	void match_set_mpls_lse(struct match *, int idx, ovs_be32 lse);
81a76618 BP	101	void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
	102	void match_set_tp_dst(struct match *, ovs_be16);
	103	void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
dc235f7f JR	104	void match_set_tcp_flags(struct match *, ovs_be16);
dc235f7f JR	105	void match_set_tcp_flags_masked(struct match *, ovs_be16 flags, ovs_be16 mask);
81a76618 BP	106	void match_set_nw_proto(struct match *, uint8_t);
	107	void match_set_nw_src(struct match *, ovs_be32);
	108	void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
	109	void match_set_nw_dst(struct match *, ovs_be32);
	110	void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
	111	void match_set_nw_dscp(struct match *, uint8_t);
	112	void match_set_nw_ecn(struct match *, uint8_t);
	113	void match_set_nw_ttl(struct match *, uint8_t);
	114	void match_set_nw_frag(struct match *, uint8_t nw_frag);
	115	void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
	116	void match_set_icmp_type(struct match *, uint8_t);
	117	void match_set_icmp_code(struct match *, uint8_t);
3bd0fd39	118	void match_set_arp_sha(struct match *, const uint8_t[ETH_ADDR_LEN]);
81a76618	119	void match_set_arp_sha_masked(struct match *,
3bd0fd39 WSH	120	const uint8_t arp_sha[ETH_ADDR_LEN],
	121	const uint8_t mask[ETH_ADDR_LEN]);
	122	void match_set_arp_tha(struct match *, const uint8_t[ETH_ADDR_LEN]);
81a76618	123	void match_set_arp_tha_masked(struct match *,
3bd0fd39 WSH	124	const uint8_t arp_tha[ETH_ADDR_LEN],
3bd0fd39 WSH	125	const uint8_t mask[ETH_ADDR_LEN]);
81a76618 BP	126	void match_set_ipv6_src(struct match , const struct in6_addr );
	127	void match_set_ipv6_src_masked(struct match , const struct in6_addr ,
	128	const struct in6_addr *);
	129	void match_set_ipv6_dst(struct match , const struct in6_addr );
	130	void match_set_ipv6_dst_masked(struct match , const struct in6_addr ,
	131	const struct in6_addr *);
	132	void match_set_ipv6_label(struct match *, ovs_be32);
	133	void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
	134	void match_set_nd_target(struct match , const struct in6_addr );
	135	void match_set_nd_target_masked(struct match , const struct in6_addr ,
	136	const struct in6_addr *);
	137
	138	bool match_equal(const struct match , const struct match );
	139	uint32_t match_hash(const struct match *, uint32_t basis);
	140
adcf00ba AZ	141	void match_init_hidden_fields(struct match *);
	142	bool match_has_default_hidden_fields(const struct match *);
	143
eb391b76 BP	144	void match_format(const struct match , struct ds , int priority);
eb391b76 BP	145	char match_to_string(const struct match , int priority);
81a76618	146	void match_print(const struct match *);
5cb7a798 BP	147	\f
	148	/* Compressed match. */
	149
	150	/* A sparse representation of a "struct match".
	151	*
df40c152	152	* There are two invariants:
5cb7a798	153	*
df40c152 BP	154	* - The same invariant as "struct match", that is, a 1-bit in the 'flow'
	155	* must correspond to a 1-bit in 'mask'.
	156	*
	157	* - 'flow' and 'mask' have the same 'map'. This implies that 'flow' and
	158	* 'mask' have the same part of "struct flow" at the same offset into
	159	* 'values', which makes minimatch_matches_flow() faster.
	160	*/
5cb7a798 BP	161	struct minimatch {
	162	struct miniflow flow;
	163	struct minimask mask;
	164	};
	165
	166	void minimatch_init(struct minimatch , const struct match );
	167	void minimatch_clone(struct minimatch , const struct minimatch );
b2c1f00b	168	void minimatch_move(struct minimatch dst, struct minimatch src);
5cb7a798 BP	169	void minimatch_destroy(struct minimatch *);
	170
	171	void minimatch_expand(const struct minimatch , struct match );
	172
	173	bool minimatch_equal(const struct minimatch a, const struct minimatch b);
5cb7a798	174
df40c152 BP	175	bool minimatch_matches_flow(const struct minimatch , const struct flow );
df40c152 BP	176
eb391b76 BP	177	void minimatch_format(const struct minimatch , struct ds , int priority);
eb391b76 BP	178	char minimatch_to_string(const struct minimatch , int priority);
81a76618 BP	179
81a76618 BP	180	#endif /* match.h */