include/openvswitch/match.h

   1 /*
   2  * Copyright (c) 2009-2017 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 OPENVSWITCH_MATCH_H
  18 #define OPENVSWITCH_MATCH_H 1
  19
  20 #include "openvswitch/flow.h"
  21 #include "openvswitch/packets.h"
  22 #include "openvswitch/tun-metadata.h"
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 struct ds;
  29 struct ofputil_port_map;
  30 struct mf_field;
  31
  32 /* A flow classification match.
  33  *
  34  * Use one of the match_*() functions to initialize a "struct match".
  35  *
  36  * The match_*() functions below maintain the following important invariant.
  37  * If a bit or a field is wildcarded in 'wc', then the corresponding bit or
  38  * field in 'flow' is set to all-0-bits.  (The match_zero_wildcarded_fields()
  39  * function can be used to restore this invariant after adding wildcards.) */
  40 struct match {
  41     struct flow flow;
  42     struct flow_wildcards wc;
  43     struct tun_metadata_allocation tun_md;
  44 };
  45
  46 /* Initializer for a "struct match" that matches every packet. */
  47 #define MATCH_CATCHALL_INITIALIZER { .flow = { .dl_type = 0 } }
  48
  49 #define MATCH_SET_FIELD_MASKED(match, field, value, msk)      \
  50     do {                                                      \
  51         (match)->wc.masks.field = (msk);                      \
  52         (match)->flow.field = (value) & (msk);                \
  53     } while (0)
  54
  55 #define MATCH_SET_FIELD_UINT8(match, field, value)            \
  56     MATCH_SET_FIELD_MASKED(match, field, value, UINT8_MAX)
  57
  58 #define MATCH_SET_FIELD_BE32(match, field, value)             \
  59     MATCH_SET_FIELD_MASKED(match, field, value, OVS_BE32_MAX)
  60
  61 void match_init(struct match *,
  62                 const struct flow *, const struct flow_wildcards *);
  63 void match_wc_init(struct match *match, const struct flow *flow);
  64 void match_init_catchall(struct match *);
  65
  66 void match_zero_wildcarded_fields(struct match *);
  67
  68 void match_set_dp_hash(struct match *, uint32_t value);
  69 void match_set_dp_hash_masked(struct match *, uint32_t value, uint32_t mask);
  70
  71 void match_set_recirc_id(struct match *, uint32_t value);
  72
  73 void match_set_conj_id(struct match *, uint32_t value);
  74
  75 void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
  76 void match_set_reg_masked(struct match *, unsigned int reg_idx,
  77                           uint32_t value, uint32_t mask);
  78 void match_set_xreg(struct match *, unsigned int xreg_idx, uint64_t value);
  79 void match_set_xreg_masked(struct match *, unsigned int xreg_idx,
  80                            uint64_t value, uint64_t mask);
  81 void match_set_xxreg(struct match *, unsigned int xxreg_idx, ovs_u128 value);
  82 void match_set_xxreg_masked(struct match *, unsigned int xxreg_idx,
  83                            ovs_u128 value, ovs_u128 mask);
  84 void match_set_actset_output(struct match *, ofp_port_t actset_output);
  85 void match_set_metadata(struct match *, ovs_be64 metadata);
  86 void match_set_metadata_masked(struct match *,
  87                                ovs_be64 metadata, ovs_be64 mask);
  88 void match_set_tun_id(struct match *, ovs_be64 tun_id);
  89 void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
  90 void match_set_tun_src(struct match *match, ovs_be32 src);
  91 void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask);
  92 void match_set_tun_dst(struct match *match, ovs_be32 dst);
  93 void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask);
  94 void match_set_tun_ipv6_src(struct match *, const struct in6_addr *);
  95 void match_set_tun_ipv6_src_masked(struct match *, const struct in6_addr *,
  96                                    const struct in6_addr *);
  97 void match_set_tun_ipv6_dst(struct match *, const struct in6_addr *);
  98 void match_set_tun_ipv6_dst_masked(struct match *, const struct in6_addr *,
  99                                    const struct in6_addr *);
 100 void match_set_tun_ttl(struct match *match, uint8_t ttl);
 101 void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask);
 102 void match_set_tun_tos(struct match *match, uint8_t tos);
 103 void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask);
 104 void match_set_tun_flags(struct match *match, uint16_t flags);
 105 void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask);
 106 void match_set_tun_tp_dst(struct match *match, ovs_be16 tp_dst);
 107 void match_set_tun_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask);
 108 void match_set_tun_tp_src(struct match *match, ovs_be16 tp_src);
 109 void match_set_tun_tp_src_masked(struct match *match,
 110                                  ovs_be16 port, ovs_be16 mask);
 111 void match_set_tun_gbp_id_masked(struct match *match, ovs_be16 gbp_id, ovs_be16 mask);
 112 void match_set_tun_gbp_id(struct match *match, ovs_be16 gbp_id);
 113 void match_set_tun_gbp_flags_masked(struct match *match, uint8_t flags, uint8_t mask);
 114 void match_set_tun_gbp_flags(struct match *match, uint8_t flags);
 115 void match_set_tun_erspan_ver(struct match *match, uint8_t ver);
 116 void match_set_tun_erspan_ver_masked(struct match *match, uint8_t ver,
 117                                      uint8_t mask);
 118 void match_set_tun_erspan_idx(struct match *match, uint32_t idx);
 119 void match_set_tun_erspan_idx_masked(struct match *match, uint32_t idx,
 120                                      uint32_t mask);
 121 void match_set_tun_erspan_dir(struct match *match, uint8_t dir);
 122 void match_set_tun_erspan_dir_masked(struct match *match, uint8_t dir,
 123                                      uint8_t mask);
 124 void match_set_tun_erspan_hwid(struct match *match, uint8_t hwid);
 125 void match_set_tun_erspan_hwid_masked(struct match *match, uint8_t hwid,
 126                                       uint8_t mask);
 127 void match_set_tun_gtpu_flags(struct match *match, uint8_t flags);
 128 void match_set_tun_gtpu_flags_masked(struct match *match, uint8_t flags,
 129                                      uint8_t mask);
 130 void match_set_tun_gtpu_msgtype(struct match *match, uint8_t msgtype);
 131 void match_set_tun_gtpu_msgtype_masked(struct match *match, uint8_t msgtype,
 132                                        uint8_t mask);
 133 void match_set_in_port(struct match *, ofp_port_t ofp_port);
 134 void match_set_pkt_mark(struct match *, uint32_t pkt_mark);
 135 void match_set_pkt_mark_masked(struct match *, uint32_t pkt_mark, uint32_t mask);
 136 void match_set_ct_state(struct match *, uint32_t ct_state);
 137 void match_set_ct_state_masked(struct match *, uint32_t ct_state, uint32_t mask);
 138 void match_set_ct_zone(struct match *, uint16_t ct_zone);
 139 void match_set_ct_zone_masked(struct match *match, uint16_t ct_zone,
 140                               uint16_t mask);
 141 void match_set_ct_mark(struct match *, uint32_t ct_mark);
 142 void match_set_ct_mark_masked(struct match *, uint32_t ct_mark, uint32_t mask);
 143 void match_set_ct_label(struct match *, ovs_u128 ct_label);
 144 void match_set_ct_label_masked(struct match *, ovs_u128 ct_label, ovs_u128 mask);
 145 void match_set_ct_nw_src(struct match *, ovs_be32);
 146 void match_set_ct_nw_src_masked(struct match *, ovs_be32, ovs_be32 mask);
 147 void match_set_ct_nw_dst(struct match *, ovs_be32);
 148 void match_set_ct_nw_dst_masked(struct match *, ovs_be32, ovs_be32 mask);
 149 void match_set_ct_nw_proto(struct match *, uint8_t);
 150 void match_set_ct_tp_src(struct match *, ovs_be16);
 151 void match_set_ct_tp_src_masked(struct match *, ovs_be16, ovs_be16 mask);
 152 void match_set_ct_tp_dst(struct match *, ovs_be16);
 153 void match_set_ct_tp_dst_masked(struct match *, ovs_be16, ovs_be16 mask);
 154 void match_set_ct_ipv6_src(struct match *, const struct in6_addr *);
 155 void match_set_ct_ipv6_src_masked(struct match *, const struct in6_addr *,
 156                                   const struct in6_addr *);
 157 void match_set_ct_ipv6_dst(struct match *, const struct in6_addr *);
 158 void match_set_ct_ipv6_dst_masked(struct match *, const struct in6_addr *,
 159                                   const struct in6_addr *);
 160
 161 void match_set_packet_type(struct match *, ovs_be32 packet_type);
 162 void match_set_default_packet_type(struct match *);
 163 bool match_has_default_packet_type(const struct match *);
 164 void match_add_ethernet_prereq(struct match *, const struct mf_field *);
 165
 166 void match_set_skb_priority(struct match *, uint32_t skb_priority);
 167 void match_set_dl_type(struct match *, ovs_be16);
 168 void match_set_dl_src(struct match *, const struct eth_addr );
 169 void match_set_dl_src_masked(struct match *, const struct eth_addr dl_src,
 170                              const struct eth_addr mask);
 171 void match_set_dl_dst(struct match *, const struct eth_addr);
 172 void match_set_dl_dst_masked(struct match *, const struct eth_addr dl_dst,
 173                              const struct eth_addr mask);
 174 void match_set_dl_tci(struct match *, ovs_be16 tci);
 175 void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
 176 void match_set_any_vid(struct match *);
 177 void match_set_dl_vlan(struct match *, ovs_be16, int id);
 178 void match_set_vlan_vid(struct match *, ovs_be16);
 179 void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
 180 void match_set_any_pcp(struct match *);
 181 void match_set_dl_vlan_pcp(struct match *, uint8_t, int id);
 182 void match_set_any_mpls_lse(struct match *, int idx);
 183 void match_set_mpls_lse(struct match *, int idx, ovs_be32);
 184 void match_set_any_mpls_label(struct match *, int idx);
 185 void match_set_mpls_label(struct match *, int idx, ovs_be32);
 186 void match_set_any_mpls_tc(struct match *, int idx);
 187 void match_set_mpls_tc(struct match *, int idx, uint8_t);
 188 void match_set_any_mpls_bos(struct match *, int idx);
 189 void match_set_mpls_bos(struct match *, int idx, uint8_t);
 190 void match_set_any_mpls_ttl(struct match *, int idx);
 191 void match_set_mpls_ttl(struct match *, int idx, uint8_t);
 192 void match_set_tp_src(struct match *, ovs_be16);
 193 void match_set_mpls_lse(struct match *, int idx, ovs_be32 lse);
 194 void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
 195 void match_set_tp_dst(struct match *, ovs_be16);
 196 void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
 197 void match_set_tcp_flags(struct match *, ovs_be16);
 198 void match_set_tcp_flags_masked(struct match *, ovs_be16 flags, ovs_be16 mask);
 199 void match_set_nw_proto(struct match *, uint8_t);
 200 void match_set_nw_src(struct match *, ovs_be32);
 201 void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
 202 void match_set_nw_dst(struct match *, ovs_be32);
 203 void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
 204 void match_set_nw_dscp(struct match *, uint8_t);
 205 void match_set_nw_ecn(struct match *, uint8_t);
 206 void match_set_nw_ttl(struct match *, uint8_t nw_ttl);
 207 void match_set_nw_ttl_masked(struct match *, uint8_t nw_ttl, uint8_t mask);
 208 void match_set_nw_tos_masked(struct match *, uint8_t nw_tos, uint8_t mask);
 209 void match_set_nw_frag(struct match *, uint8_t nw_frag);
 210 void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
 211 void match_set_icmp_type(struct match *, uint8_t);
 212 void match_set_icmp_code(struct match *, uint8_t);
 213 void match_set_arp_sha(struct match *, const struct eth_addr);
 214 void match_set_arp_sha_masked(struct match *,
 215                               const struct eth_addr arp_sha,
 216                               const struct eth_addr mask);
 217 void match_set_arp_tha(struct match *, const struct eth_addr);
 218 void match_set_arp_tha_masked(struct match *,
 219                               const struct eth_addr arp_tha,
 220                               const struct eth_addr mask);
 221 void match_set_ipv6_src(struct match *, const struct in6_addr *);
 222 void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
 223                                const struct in6_addr *);
 224 void match_set_ipv6_dst(struct match *, const struct in6_addr *);
 225 void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
 226                                const struct in6_addr *);
 227 void match_set_ipv6_label(struct match *, ovs_be32);
 228 void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
 229 void match_set_nd_target(struct match *, const struct in6_addr *);
 230 void match_set_nd_target_masked(struct match *, const struct in6_addr *,
 231                                 const struct in6_addr *);
 232
 233 void match_set_nd_reserved(struct match *, ovs_be32);
 234 void match_set_nd_options_type(struct match *, uint8_t);
 235
 236 bool match_equal(const struct match *, const struct match *);
 237 uint32_t match_hash(const struct match *, uint32_t basis);
 238
 239 void match_init_hidden_fields(struct match *);
 240 bool match_has_default_hidden_fields(const struct match *);
 241
 242 void match_format(const struct match *, const struct ofputil_port_map *,
 243                   struct ds *, int priority);
 244 char *match_to_string(const struct match *, const struct ofputil_port_map *,
 245                       int priority);
 246 void match_print(const struct match *, const struct ofputil_port_map *);
 247 \f
 248 /* Compressed match. */
 249
 250 /* A sparse representation of a "struct match".
 251  *
 252  * 'flows' is used for allocating both 'flow' and 'mask' with one
 253  * miniflow_alloc() call.
 254  *
 255  * There are two invariants:
 256  *
 257  *   - The same invariant as "struct match", that is, a 1-bit in the 'flow'
 258  *     must correspond to a 1-bit in 'mask'.
 259  *
 260  *   - 'flow' and 'mask' have the same 'map'.  This implies that 'flow' and
 261  *     'mask' have the same part of "struct flow" at the same offset into
 262  *     'values', which makes minimatch_matches_flow() faster.
 263  */
 264 struct minimatch {
 265     union {
 266         struct {
 267             struct miniflow *flow;
 268             struct minimask *mask;
 269         };
 270         struct miniflow *flows[2];
 271     };
 272     struct tun_metadata_allocation *tun_md;
 273 };
 274
 275 void minimatch_init(struct minimatch *, const struct match *);
 276 void minimatch_init_catchall(struct minimatch *);
 277 void minimatch_clone(struct minimatch *, const struct minimatch *);
 278 void minimatch_move(struct minimatch *dst, struct minimatch *src);
 279 void minimatch_destroy(struct minimatch *);
 280
 281 void minimatch_expand(const struct minimatch *, struct match *);
 282
 283 bool minimatch_equal(const struct minimatch *a, const struct minimatch *b);
 284 uint32_t minimatch_hash(const struct minimatch *, uint32_t basis);
 285
 286 bool minimatch_matches_flow(const struct minimatch *, const struct flow *);
 287
 288 void minimatch_format(const struct minimatch *, const struct tun_table *,
 289                       const struct ofputil_port_map *,
 290                       struct ds *, int priority);
 291 char *minimatch_to_string(const struct minimatch *,
 292                           const struct ofputil_port_map *, int priority);
 293
 294 bool minimatch_has_default_hidden_fields(const struct minimatch *);
 295
 296 #ifdef __cplusplus
 297 }
 298 #endif
 299
 300 #endif /* match.h */