lib/classifier.h

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   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 CLASSIFIER_H
  18 #define CLASSIFIER_H 1
  19
  20 /* Flow classifier.
  21  *
  22  * A classifier is a "struct classifier",
  23  *      a hash map from a set of wildcards to a "struct cls_table",
  24  *              a hash map from fixed field values to "struct cls_rule",
  25  *                      which can contain a list of otherwise identical rules
  26  *                      with lower priorities.
  27  */
  28
  29 #include "flow.h"
  30 #include "hmap.h"
  31 #include "list.h"
  32 #include "openflow/nicira-ext.h"
  33 #include "openflow/openflow.h"
  34
  35 /* A flow classifier. */
  36 struct classifier {
  37     int n_rules;                /* Total number of rules. */
  38     struct hmap tables;         /* Contains "struct cls_table"s.  */
  39 };
  40
  41 /* A set of rules that all have the same fields wildcarded. */
  42 struct cls_table {
  43     struct hmap_node hmap_node; /* Within struct classifier 'wctables'. */
  44     struct hmap rules;          /* Contains "struct cls_rule"s. */
  45     struct flow_wildcards wc;   /* Wildcards for fields. */
  46     int n_table_rules;          /* Number of rules, including duplicates. */
  47     int n_refs;                 /* Reference count used during iteration. */
  48 };
  49
  50 /* A flow classification rule.
  51  *
  52  * Use one of the cls_rule_*() functions to initialize a cls_rule.
  53  *
  54  * The cls_rule_*() functions below maintain the following important
  55  * invariant that the classifier depends on:
  56  *
  57  *   - If a bit or a field is wildcarded in 'wc', then the corresponding bit or
  58  *     field in 'flow' is set to all-0-bits.  (The
  59  *     cls_rule_zero_wildcarded_fields() function can be used to restore this
  60  *     invariant after adding wildcards.)
  61  */
  62 struct cls_rule {
  63     struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
  64     struct list list;           /* List of identical, lower-priority rules. */
  65     struct flow flow;           /* All field values. */
  66     struct flow_wildcards wc;   /* Wildcards for fields. */
  67     unsigned int priority;      /* Larger numbers are higher priorities. */
  68 };
  69
  70 void cls_rule_init(const struct flow *, const struct flow_wildcards *,
  71                    unsigned int priority, struct cls_rule *);
  72 void cls_rule_init_exact(const struct flow *, unsigned int priority,
  73                          struct cls_rule *);
  74 void cls_rule_from_match(const struct ofp_match *, unsigned int priority,
  75                          int flow_format, uint64_t cookie, struct cls_rule *);
  76 void cls_rule_init_catchall(struct cls_rule *, unsigned int priority);
  77
  78 void cls_rule_zero_wildcarded_fields(struct cls_rule *);
  79
  80 void cls_rule_set_in_port(struct cls_rule *, uint16_t odp_port);
  81 void cls_rule_set_dl_type(struct cls_rule *, ovs_be16);
  82 void cls_rule_set_dl_src(struct cls_rule *, const uint8_t[6]);
  83 void cls_rule_set_dl_dst(struct cls_rule *, const uint8_t[6]);
  84 bool cls_rule_set_dl_tci(struct cls_rule *, ovs_be16 tci);
  85 bool cls_rule_set_dl_tci_masked(struct cls_rule *,
  86                                 ovs_be16 tci, ovs_be16 mask);
  87 void cls_rule_set_dl_vlan(struct cls_rule *, ovs_be16);
  88 void cls_rule_set_dl_vlan_pcp(struct cls_rule *, uint8_t);
  89 void cls_rule_set_tp_src(struct cls_rule *, ovs_be16);
  90 void cls_rule_set_tp_dst(struct cls_rule *, ovs_be16);
  91 void cls_rule_set_nw_proto(struct cls_rule *, uint8_t);
  92 void cls_rule_set_nw_src(struct cls_rule *, ovs_be32);
  93 bool cls_rule_set_nw_src_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
  94 void cls_rule_set_nw_dst(struct cls_rule *, ovs_be32);
  95 bool cls_rule_set_nw_dst_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
  96 void cls_rule_set_nw_tos(struct cls_rule *, uint8_t);
  97 void cls_rule_set_icmp_type(struct cls_rule *, uint8_t);
  98 void cls_rule_set_icmp_code(struct cls_rule *, uint8_t);
  99
 100 char *cls_rule_to_string(const struct cls_rule *);
 101 void cls_rule_print(const struct cls_rule *);
 102
 103 void classifier_init(struct classifier *);
 104 void classifier_destroy(struct classifier *);
 105 bool classifier_is_empty(const struct classifier *);
 106 int classifier_count(const struct classifier *);
 107 struct cls_rule *classifier_insert(struct classifier *, struct cls_rule *);
 108 void classifier_remove(struct classifier *, struct cls_rule *);
 109 struct cls_rule *classifier_lookup(const struct classifier *,
 110                                    const struct flow *);
 111 bool classifier_rule_overlaps(const struct classifier *,
 112                               const struct cls_rule *);
 113
 114 typedef void cls_cb_func(struct cls_rule *, void *aux);
 115
 116 void classifier_for_each(const struct classifier *,
 117                          cls_cb_func *, void *aux);
 118 void classifier_for_each_match(const struct classifier *,
 119                                const struct cls_rule *,
 120                                cls_cb_func *, void *aux);
 121 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
 122                                               const struct cls_rule *);
 123
 124 #endif /* classifier.h */