mirror of
https://github.com/openvswitch/ovs
synced 2025-08-22 01:51:26 +00:00
3245502404
Signed-off-by: Simon Horman <horms@verge.net.au> Signed-off-by: Ben Pfaff <blp@nicira.com>
206 lines
9.0 KiB
C
206 lines
9.0 KiB
C
/*
|
||
* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
|
||
*
|
||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
* you may not use this file except in compliance with the License.
|
||
* You may obtain a copy of the License at:
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing, software
|
||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
* See the License for the specific language governing permissions and
|
||
* limitations under the License.
|
||
*/
|
||
|
||
#ifndef CLASSIFIER_H
|
||
#define CLASSIFIER_H 1
|
||
|
||
/* Flow classifier.
|
||
*
|
||
* A classifier is a "struct classifier",
|
||
* a hash map from a set of wildcards to a "struct cls_table",
|
||
* a hash map from fixed field values to "struct cls_rule",
|
||
* which can contain a list of otherwise identical rules
|
||
* with lower priorities.
|
||
*/
|
||
|
||
#include "flow.h"
|
||
#include "hmap.h"
|
||
#include "list.h"
|
||
#include "openflow/nicira-ext.h"
|
||
#include "openflow/openflow.h"
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif
|
||
|
||
/* A flow classifier. */
|
||
struct classifier {
|
||
int n_rules; /* Total number of rules. */
|
||
struct hmap tables; /* Contains "struct cls_table"s. */
|
||
};
|
||
|
||
/* A set of rules that all have the same fields wildcarded. */
|
||
struct cls_table {
|
||
struct hmap_node hmap_node; /* Within struct classifier 'tables' hmap. */
|
||
struct hmap rules; /* Contains "struct cls_rule"s. */
|
||
struct flow_wildcards wc; /* Wildcards for fields. */
|
||
int n_table_rules; /* Number of rules, including duplicates. */
|
||
bool is_catchall; /* True if this table wildcards every field. */
|
||
};
|
||
|
||
/* Returns true if 'table' is a "catch-all" table that will match every
|
||
* packet (if there is no higher-priority match). */
|
||
static inline bool
|
||
cls_table_is_catchall(const struct cls_table *table)
|
||
{
|
||
return table->is_catchall;
|
||
}
|
||
|
||
/* A flow classification rule.
|
||
*
|
||
* Use one of the cls_rule_*() functions to initialize a cls_rule.
|
||
*
|
||
* The cls_rule_*() functions below maintain the following important
|
||
* invariant that the classifier depends on:
|
||
*
|
||
* - If a bit or a field is wildcarded in 'wc', then the corresponding bit or
|
||
* field in 'flow' is set to all-0-bits. (The
|
||
* cls_rule_zero_wildcarded_fields() function can be used to restore this
|
||
* invariant after adding wildcards.)
|
||
*/
|
||
struct cls_rule {
|
||
struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
|
||
struct list list; /* List of identical, lower-priority rules. */
|
||
struct flow flow; /* All field values. */
|
||
struct flow_wildcards wc; /* Wildcards for fields. */
|
||
unsigned int priority; /* Larger numbers are higher priorities. */
|
||
};
|
||
|
||
void cls_rule_init(const struct flow *, const struct flow_wildcards *,
|
||
unsigned int priority, struct cls_rule *);
|
||
void cls_rule_init_exact(const struct flow *, unsigned int priority,
|
||
struct cls_rule *);
|
||
void cls_rule_init_catchall(struct cls_rule *, unsigned int priority);
|
||
|
||
void cls_rule_zero_wildcarded_fields(struct cls_rule *);
|
||
|
||
bool cls_rule_is_loose_match(const struct cls_rule *rule,
|
||
const struct cls_rule *criteria);
|
||
|
||
void cls_rule_set_reg(struct cls_rule *, unsigned int reg_idx, uint32_t value);
|
||
void cls_rule_set_reg_masked(struct cls_rule *, unsigned int reg_idx,
|
||
uint32_t value, uint32_t mask);
|
||
void cls_rule_set_metadata(struct cls_rule *, ovs_be64 metadata);
|
||
void cls_rule_set_metadata_masked(struct cls_rule *, ovs_be64 metadata,
|
||
ovs_be64 mask);
|
||
void cls_rule_set_tun_id(struct cls_rule *, ovs_be64 tun_id);
|
||
void cls_rule_set_tun_id_masked(struct cls_rule *,
|
||
ovs_be64 tun_id, ovs_be64 mask);
|
||
void cls_rule_set_in_port(struct cls_rule *, uint16_t ofp_port);
|
||
void cls_rule_set_dl_type(struct cls_rule *, ovs_be16);
|
||
void cls_rule_set_dl_src(struct cls_rule *, const uint8_t[6]);
|
||
void cls_rule_set_dl_src_masked(struct cls_rule *, const uint8_t dl_src[6],
|
||
const uint8_t mask[6]);
|
||
void cls_rule_set_dl_dst(struct cls_rule *, const uint8_t[6]);
|
||
void cls_rule_set_dl_dst_masked(struct cls_rule *, const uint8_t dl_dst[6],
|
||
const uint8_t mask[6]);
|
||
void cls_rule_set_dl_tci(struct cls_rule *, ovs_be16 tci);
|
||
void cls_rule_set_dl_tci_masked(struct cls_rule *,
|
||
ovs_be16 tci, ovs_be16 mask);
|
||
void cls_rule_set_any_vid(struct cls_rule *);
|
||
void cls_rule_set_dl_vlan(struct cls_rule *, ovs_be16);
|
||
void cls_rule_set_any_pcp(struct cls_rule *);
|
||
void cls_rule_set_dl_vlan_pcp(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_tp_src(struct cls_rule *, ovs_be16);
|
||
void cls_rule_set_tp_src_masked(struct cls_rule *,
|
||
ovs_be16 port, ovs_be16 mask);
|
||
void cls_rule_set_tp_dst(struct cls_rule *, ovs_be16);
|
||
void cls_rule_set_tp_dst_masked(struct cls_rule *,
|
||
ovs_be16 port, ovs_be16 mask);
|
||
void cls_rule_set_nw_proto(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_nw_src(struct cls_rule *, ovs_be32);
|
||
void cls_rule_set_nw_src_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
|
||
void cls_rule_set_nw_dst(struct cls_rule *, ovs_be32);
|
||
void cls_rule_set_nw_dst_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
|
||
void cls_rule_set_nw_dscp(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_nw_ecn(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_nw_ttl(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_nw_frag(struct cls_rule *, uint8_t nw_frag);
|
||
void cls_rule_set_nw_frag_masked(struct cls_rule *,
|
||
uint8_t nw_frag, uint8_t mask);
|
||
void cls_rule_set_icmp_type(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_icmp_code(struct cls_rule *, uint8_t);
|
||
void cls_rule_set_arp_sha(struct cls_rule *, const uint8_t[6]);
|
||
void cls_rule_set_arp_tha(struct cls_rule *, const uint8_t[6]);
|
||
void cls_rule_set_ipv6_src(struct cls_rule *, const struct in6_addr *);
|
||
void cls_rule_set_ipv6_src_masked(struct cls_rule *, const struct in6_addr *,
|
||
const struct in6_addr *);
|
||
void cls_rule_set_ipv6_dst(struct cls_rule *, const struct in6_addr *);
|
||
void cls_rule_set_ipv6_dst_masked(struct cls_rule *, const struct in6_addr *,
|
||
const struct in6_addr *);
|
||
void cls_rule_set_ipv6_label(struct cls_rule *, ovs_be32);
|
||
void cls_rule_set_ipv6_label_masked(struct cls_rule *, ovs_be32, ovs_be32);
|
||
void cls_rule_set_nd_target(struct cls_rule *, const struct in6_addr *);
|
||
void cls_rule_set_nd_target_masked(struct cls_rule *, const struct in6_addr *,
|
||
const struct in6_addr *);
|
||
|
||
bool cls_rule_equal(const struct cls_rule *, const struct cls_rule *);
|
||
uint32_t cls_rule_hash(const struct cls_rule *, uint32_t basis);
|
||
|
||
void cls_rule_format(const struct cls_rule *, struct ds *);
|
||
char *cls_rule_to_string(const struct cls_rule *);
|
||
void cls_rule_print(const struct cls_rule *);
|
||
|
||
void classifier_init(struct classifier *);
|
||
void classifier_destroy(struct classifier *);
|
||
bool classifier_is_empty(const struct classifier *);
|
||
int classifier_count(const struct classifier *);
|
||
void classifier_insert(struct classifier *, struct cls_rule *);
|
||
struct cls_rule *classifier_replace(struct classifier *, struct cls_rule *);
|
||
void classifier_remove(struct classifier *, struct cls_rule *);
|
||
struct cls_rule *classifier_lookup(const struct classifier *,
|
||
const struct flow *);
|
||
bool classifier_rule_overlaps(const struct classifier *,
|
||
const struct cls_rule *);
|
||
|
||
typedef void cls_cb_func(struct cls_rule *, void *aux);
|
||
|
||
struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
|
||
const struct cls_rule *);
|
||
|
||
/* Iteration. */
|
||
|
||
struct cls_cursor {
|
||
const struct classifier *cls;
|
||
const struct cls_table *table;
|
||
const struct cls_rule *target;
|
||
};
|
||
|
||
void cls_cursor_init(struct cls_cursor *, const struct classifier *,
|
||
const struct cls_rule *match);
|
||
struct cls_rule *cls_cursor_first(struct cls_cursor *);
|
||
struct cls_rule *cls_cursor_next(struct cls_cursor *, struct cls_rule *);
|
||
|
||
#define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR) \
|
||
for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
|
||
&(RULE)->MEMBER != NULL; \
|
||
ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
|
||
MEMBER))
|
||
|
||
#define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR) \
|
||
for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
|
||
(&(RULE)->MEMBER != NULL \
|
||
? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
|
||
MEMBER) \
|
||
: 0); \
|
||
(RULE) = (NEXT))
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif
|
||
|
||
#endif /* classifier.h */
|