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