[mirror_ovs.git] / lib / match.h

/*
 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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"

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_init_exact(struct match *, const struct flow *);

void match_zero_wildcarded_fields(struct match *);

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_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[6]);
void match_set_dl_src_masked(struct match *, const uint8_t dl_src[6],
                             const uint8_t mask[6]);
void match_set_dl_dst(struct match *, const uint8_t[6]);
void match_set_dl_dst_masked(struct match *, const uint8_t dl_dst[6],
                             const uint8_t mask[6]);
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_label(struct match *);
void match_set_mpls_label(struct match *, ovs_be32);
void match_set_any_mpls_tc(struct match *);
void match_set_mpls_tc(struct match *, uint8_t);
void match_set_any_mpls_bos(struct match *);
void match_set_mpls_bos(struct match *, uint8_t);
void match_set_tp_src(struct match *, ovs_be16);
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_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[6]);
void match_set_arp_sha_masked(struct match *,
                              const uint8_t arp_sha[6],
                              const uint8_t mask[6]);
void match_set_arp_tha(struct match *, const uint8_t[6]);
void match_set_arp_tha_masked(struct match *,
                              const uint8_t arp_tha[6],
                              const uint8_t mask[6]);
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_format(const struct match *, struct ds *, unsigned int priority);
char *match_to_string(const struct match *, unsigned int priority);
void match_print(const struct match *);
\f
/* Compressed match. */

/* A sparse representation of a "struct match".
 *
 * This has the same invariant as "struct match", that is, a 1-bit in the
 * 'flow' must correspond to a 1-bit in 'mask'.
 *
 * The invariants for the underlying miniflow and minimask are also maintained,
 * which means that 'flow' and 'mask' can have different 'map's.  In
 * particular, if the match checks that a given 32-bit field has value 0, then
 * 'map' will have a 1-bit in 'mask' but a 0-bit in 'flow' for that field. */
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);
uint32_t minimatch_hash(const struct minimatch *, uint32_t basis);

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

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