lib/match.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 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 /* A flow classification match.
  23  *
  24  * Use one of the match_*() functions to initialize a "struct match".
  25  *
  26  * The match_*() functions below maintain the following important invariant.
  27  * If a bit or a field is wildcarded in 'wc', then the corresponding bit or
  28  * field in 'flow' is set to all-0-bits.  (The match_zero_wildcarded_fields()
  29  * function can be used to restore this invariant after adding wildcards.) */
  30 struct match {
  31     struct flow flow;
  32     struct flow_wildcards wc;
  33 };
  34
  35 void match_init(struct match *,
  36                 const struct flow *, const struct flow_wildcards *);
  37 void match_init_catchall(struct match *);
  38 void match_init_exact(struct match *, const struct flow *);
  39
  40 void match_zero_wildcarded_fields(struct match *);
  41
  42 void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
  43 void match_set_reg_masked(struct match *, unsigned int reg_idx,
  44                           uint32_t value, uint32_t mask);
  45 void match_set_metadata(struct match *, ovs_be64 metadata);
  46 void match_set_metadata_masked(struct match *,
  47                                ovs_be64 metadata, ovs_be64 mask);
  48 void match_set_tun_id(struct match *, ovs_be64 tun_id);
  49 void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
  50 void match_set_in_port(struct match *, uint16_t ofp_port);
  51 void match_set_dl_type(struct match *, ovs_be16);
  52 void match_set_dl_src(struct match *, const uint8_t[6]);
  53 void match_set_dl_src_masked(struct match *, const uint8_t dl_src[6],
  54                              const uint8_t mask[6]);
  55 void match_set_dl_dst(struct match *, const uint8_t[6]);
  56 void match_set_dl_dst_masked(struct match *, const uint8_t dl_dst[6],
  57                              const uint8_t mask[6]);
  58 void match_set_dl_tci(struct match *, ovs_be16 tci);
  59 void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
  60 void match_set_any_vid(struct match *);
  61 void match_set_dl_vlan(struct match *, ovs_be16);
  62 void match_set_vlan_vid(struct match *, ovs_be16);
  63 void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
  64 void match_set_any_pcp(struct match *);
  65 void match_set_dl_vlan_pcp(struct match *, uint8_t);
  66 void match_set_tp_src(struct match *, ovs_be16);
  67 void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
  68 void match_set_tp_dst(struct match *, ovs_be16);
  69 void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
  70 void match_set_nw_proto(struct match *, uint8_t);
  71 void match_set_nw_src(struct match *, ovs_be32);
  72 void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
  73 void match_set_nw_dst(struct match *, ovs_be32);
  74 void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
  75 void match_set_nw_dscp(struct match *, uint8_t);
  76 void match_set_nw_ecn(struct match *, uint8_t);
  77 void match_set_nw_ttl(struct match *, uint8_t);
  78 void match_set_nw_frag(struct match *, uint8_t nw_frag);
  79 void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
  80 void match_set_icmp_type(struct match *, uint8_t);
  81 void match_set_icmp_code(struct match *, uint8_t);
  82 void match_set_arp_sha(struct match *, const uint8_t[6]);
  83 void match_set_arp_sha_masked(struct match *,
  84                               const uint8_t arp_sha[6],
  85                               const uint8_t mask[6]);
  86 void match_set_arp_tha(struct match *, const uint8_t[6]);
  87 void match_set_arp_tha_masked(struct match *,
  88                               const uint8_t arp_tha[6],
  89                               const uint8_t mask[6]);
  90 void match_set_ipv6_src(struct match *, const struct in6_addr *);
  91 void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
  92                                const struct in6_addr *);
  93 void match_set_ipv6_dst(struct match *, const struct in6_addr *);
  94 void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
  95                                const struct in6_addr *);
  96 void match_set_ipv6_label(struct match *, ovs_be32);
  97 void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
  98 void match_set_nd_target(struct match *, const struct in6_addr *);
  99 void match_set_nd_target_masked(struct match *, const struct in6_addr *,
 100                                 const struct in6_addr *);
 101
 102 bool match_equal(const struct match *, const struct match *);
 103 uint32_t match_hash(const struct match *, uint32_t basis);
 104
 105 void match_format(const struct match *, struct ds *, unsigned int priority);
 106 char *match_to_string(const struct match *, unsigned int priority);
 107 void match_print(const struct match *);
 108
 109 #endif /* match.h */