lib/match.h

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