2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-30 22:05:19 +00:00

classifier: Prepare for "struct cls_rule" needing to be destroyed.

Until now, "struct cls_rule" didn't own any data outside its own memory
block.  An upcoming commit will make "struct cls_rule" sometimes own blocks
of memory, so it needs "destroy" and to a lesser extent "clone" functions.
This commit adds these in advance, even though they are mostly no-ops, to
make it possible to separately review the memory management.

Signed-off-by: Ben Pfaff <blp@nicira.com>
This commit is contained in:
Ben Pfaff
2012-08-20 11:29:43 -07:00
parent 81a76618be
commit 48d28ac161
5 changed files with 80 additions and 18 deletions

View File

@@ -56,6 +56,8 @@ static struct cls_rule *next_rule_in_list(struct cls_rule *);
/* Initializes 'rule' to match packets specified by 'match' at the given
* 'priority'.
*
* The caller must eventually destroy 'rule' with cls_rule_destroy().
*
* 'match' must satisfy the invariant described in the comment at the
* definition of struct match.
*
@@ -69,6 +71,25 @@ cls_rule_init(struct cls_rule *rule,
rule->priority = priority;
}
/* Initializes 'dst' as a copy of 'src'.
*
* The caller must eventually destroy 'rule' with cls_rule_destroy(). */
void
cls_rule_clone(struct cls_rule *dst, const struct cls_rule *src)
{
*dst = *src;
}
/* Frees memory referenced by 'rule'. Doesn't free 'rule' itself (it's
* normally embedded into a larger structure).
*
* ('rule' must not currently be in a classifier.) */
void
cls_rule_destroy(struct cls_rule *rule OVS_UNUSED)
{
/* Nothing to do yet. */
}
/* Returns true if 'a' and 'b' match the same packets at the same priority,
* false if they differ in some way. */
bool
@@ -137,7 +158,8 @@ classifier_count(const struct classifier *cls)
* If 'cls' already contains an identical rule (including wildcards, values of
* fixed fields, and priority), replaces the old rule by 'rule' and returns the
* rule that was replaced. The caller takes ownership of the returned rule and
* is thus responsible for freeing it, etc., as necessary.
* is thus responsible for destroying it with cls_rule_destroy(), freeing the
* memory block in which it resides, etc., as necessary.
*
* Returns NULL if 'cls' does not contain a rule with an identical key, after
* inserting the new rule. In this case, no rules are displaced by the new
@@ -175,8 +197,9 @@ classifier_insert(struct classifier *cls, struct cls_rule *rule)
assert(!displaced_rule);
}
/* Removes 'rule' from 'cls'. It is the caller's responsibility to free
* 'rule', if this is desirable. */
/* Removes 'rule' from 'cls'. It is the caller's responsibility to destroy
* 'rule' with cls_rule_destroy(), freeing the memory block in which 'rule'
* resides, etc., as necessary. */
void
classifier_remove(struct classifier *cls, struct cls_rule *rule)
{
@@ -261,6 +284,7 @@ classifier_find_match_exactly(const struct classifier *cls,
cls_rule_init(&cr, target, priority);
retval = classifier_find_rule_exactly(cls, &cr);
cls_rule_destroy(&cr);
return retval;
}