Skip to contentSkip to conversation

audit: rebalance and remove extra layers of watch references

PATCH In review Richard Guy Briggs 2 participants 8 messages Jul 14, 2015 – Jul 17, 2015 Audit

lore
Share & tools
lore
#0 lore raw

v6 cover audit: rebalance and remove extra layers of watch references

While working on the audit by executable path feature, it was discovered that watches and parent references were slightly imbalanced and deeper than necessary.

Only bump up references when they are actually used and decrease when removed.

Richard Guy Briggs (2):
audit: eliminate unnecessary extra layer of watch references
audit: eliminate unnecessary extra layer of watch parent references

 kernel/audit_watch.c |   11 ++++-------
 kernel/auditfilter.c |    9 ---------
 2 files changed, 4 insertions(+), 16 deletions(-)
#1 lore raw

PATCH v6 1/2 audit: eliminate unnecessary extra layer of watch references

The audit watch count was imbalanced, adding an unnecessary layer of watch references. Only add the second reference when it is added to a parent.

---
 kernel/audit_watch.c |    5 ++---
 kernel/auditfilter.c |    9 ---------
 2 files changed, 2 insertions(+), 12 deletions(-)
kernel/audit_watch.c +2 -3
index 6e30024..f33f54c 100644
@@ -203,7 +203,6 @@ int audit_to_watch(struct audit_krule *krule, char *path, int len, u32 op)
 	if (IS_ERR(watch))
 		return PTR_ERR(watch);
 
-	audit_get_watch(watch);
 	krule->watch = watch;
 
 	return 0;
@@ -387,8 +386,7 @@ static void audit_add_to_parent(struct audit_krule *krule,
 
 		watch_found = 1;
 
-		/* put krule's and initial refs to temporary watch */
-		audit_put_watch(watch);
+		/* put krule's ref to temporary watch */
 		audit_put_watch(watch);
 
 		audit_get_watch(w);
@@ -400,6 +398,7 @@ static void audit_add_to_parent(struct audit_krule *krule,
 		audit_get_parent(parent);
 		watch->parent = parent;
 
+		audit_get_watch(watch);
 		list_add(&watch->wlist, &parent->watches);
 	}
 	list_add(&krule->rlist, &watch->rules);
kernel/auditfilter.c +0 -9
index 72e1660..74cc077 100644
@@ -549,8 +549,6 @@ exit_nofree:
 	return entry;
 
 exit_free:
-	if (entry->rule.watch)
-		audit_put_watch(entry->rule.watch); /* matches initial get */
 	if (entry->rule.tree)
 		audit_put_tree(entry->rule.tree); /* that's the temporary one */
 	audit_free_rule(entry);
@@ -933,11 +931,7 @@ static inline int audit_add_rule(struct audit_entry *entry)
 #endif
 	mutex_unlock(&audit_filter_mutex);
 
- 	return 0;
-
 error:
-	if (watch)
-		audit_put_watch(watch); /* tmp watch, matches initial get */
 	return err;
 }
 
@@ -945,7 +939,6 @@ error:
 static inline int audit_del_rule(struct audit_entry *entry)
 {
 	struct audit_entry  *e;
-	struct audit_watch *watch = entry->rule.watch;
 	struct audit_tree *tree = entry->rule.tree;
 	struct list_head *list;
 	int ret = 0;
@@ -986,8 +979,6 @@ static inline int audit_del_rule(struct audit_entry *entry)
 	mutex_unlock(&audit_filter_mutex);
 
 out:
-	if (watch)
-		audit_put_watch(watch); /* match initial get */
 	if (tree)
 		audit_put_tree(tree);	/* that's the temporary one */
 
Signature · 1 line
1.7.1
#2 lore raw

Re: [PATCH V6 1/2] audit: eliminate unnecessary extra layer of watch references

Quoted 8 lines · Richard Guy Briggs

The audit watch count was imbalanced, adding an unnecessary layer of watch references. Only add the second reference when it is added to a parent.

---
 kernel/audit_watch.c |    5 ++---
 kernel/auditfilter.c |    9 ---------
 2 files changed, 2 insertions(+), 12 deletions(-)

Nice catch, we never needed that extra refcnt bump in audit_to_watch(). One minor comment below...

Quoted 14 lines
kernel/auditfilter.c +0 -2
index 72e1660..74cc077 100644
@@ -549,8 +549,6 @@ exit_nofree:
 	return entry;
 
 exit_free:
-	if (entry->rule.watch)
-		audit_put_watch(entry->rule.watch); /* matches initial get */
 	if (entry->rule.tree)
 		audit_put_tree(entry->rule.tree); /* that's the temporary one */
 	audit_free_rule(entry);

kernel/auditfilter.c static inline int audit_add_rule(struct audit_entry · line 936

Quoted 10 lines
kernel/auditfilter.c +0 -4
@@ -933,11 +931,7 @@ static inline int audit_add_rule(struct audit_entry
 *entry) #endif
 	mutex_unlock(&audit_filter_mutex);
 
- 	return 0;
-
 error:
-	if (watch)
-		audit_put_watch(watch); /* tmp watch, matches initial get */
 	return err;
 }

Since the error label is now just a "return err;", how about removing the label entirely and replacing the gotos with returns?

Signature · 2 lines
paul moore
security @ redhat
#3 lore raw

Re: [PATCH V6 1/2] audit: eliminate unnecessary extra layer of watch references

Quoted 30 lines · Paul Moore
Quoted 8 lines · Richard Guy Briggs

The audit watch count was imbalanced, adding an unnecessary layer of watch references. Only add the second reference when it is added to a parent.

---
 kernel/audit_watch.c |    5 ++---
 kernel/auditfilter.c |    9 ---------
 2 files changed, 2 insertions(+), 12 deletions(-)

Nice catch, we never needed that extra refcnt bump in audit_to_watch(). One minor comment below...

Quoted 17 lines
kernel/auditfilter.c +0 -2
index 72e1660..74cc077 100644
@@ -549,8 +549,6 @@ exit_nofree:
 	return entry;
 
 exit_free:
-	if (entry->rule.watch)
-		audit_put_watch(entry->rule.watch); /* matches initial get */
 	if (entry->rule.tree)
 		audit_put_tree(entry->rule.tree); /* that's the temporary one */
 	audit_free_rule(entry);
@@ -933,11 +931,7 @@ static inline int audit_add_rule(struct audit_entry
 *entry) #endif
 	mutex_unlock(&audit_filter_mutex);
 
Quoted 10 lines

kernel/auditfilter.c static inline int audit_add_rule(struct audit_entry *entry) · line 936

Quoted 7 lines
kernel/auditfilter.c +0 -4
- 	return 0;
-
 error:
-	if (watch)
-		audit_put_watch(watch); /* tmp watch, matches initial get */
 	return err;
 }

Since the error label is now just a "return err;", how about removing the label entirely and replacing the gotos with returns?

Yup, sounds reasonable.

Quoted 1 line

paul moore

- RGB

--
Richard Guy Briggs <[email protected]>
Senior Software Engineer, Kernel Security, AMER ENG Base Operating Systems, Red Hat Remote, Ottawa, Canada
Voice: +1.647.777.2635, Internal: (81) 32635, Alt: +1.613.693.0684x3545

#4 lore raw

PATCH v6 2/2 audit: eliminate unnecessary extra layer of watch parent references

In reply to Richard Guy Briggs

The audit watch parent count was imbalanced, adding an unnecessary layer of watch parent references. Decrement the additional parent reference when a watch is reused, already having a reference to the parent.

---
 kernel/audit_watch.c |    6 ++----
 1 files changed, 2 insertions(+), 4 deletions(-)
kernel/audit_watch.c +2 -4
index f33f54c..8f123d7 100644
@@ -391,11 +391,12 @@ static void audit_add_to_parent(struct audit_krule *krule,
 
 		audit_get_watch(w);
 		krule->watch = watch = w;
+
+		audit_put_parent(parent);
 		break;
 	}
 
 	if (!watch_found) {
-		audit_get_parent(parent);
 		watch->parent = parent;
 
 		audit_get_watch(watch);
@@ -436,9 +437,6 @@ int audit_add_watch(struct audit_krule *krule, struct list_head **list)
 
 	audit_add_to_parent(krule, parent);
 
-	/* match get in audit_find_parent or audit_init_parent */
-	audit_put_parent(parent);
-
 	h = audit_hash_ino((u32)watch->ino);
 	*list = &audit_inode_hash[h];
 error:
Signature · 1 line
1.7.1
#5 lore raw

Re: [PATCH V6 2/2] audit: eliminate unnecessary extra layer of watch parent references

Quoted 16 lines · Richard Guy Briggs

The audit watch parent count was imbalanced, adding an unnecessary layer of watch parent references. Decrement the additional parent reference when a watch is reused, already having a reference to the parent.

---
 kernel/audit_watch.c |    6 ++----
 1 files changed, 2 insertions(+), 4 deletions(-)
kernel/audit_watch.c +0 -0
index f33f54c..8f123d7 100644
@@ -391,11 +391,12 @@ static void audit_add_to_parent(struct audit_krule
 *krule,
 

kernel/audit_watch.c static void audit_add_to_parent(struct audit_krule · line 401

Quoted 10 lines
kernel/audit_watch.c +2 -1
 		audit_get_watch(w);
 		krule->watch = watch = w;
+
+		audit_put_parent(parent);
 		break;
 	}
 
 	if (!watch_found) {
-		audit_get_parent(parent);
 		watch->parent = parent;

I understand removing the get() here and the put() in audit_add_watch, but I don't understand adding the put() above, can you help me understand?

Quoted 12 lines
kernel/audit_watch.c +0 -3
 		audit_get_watch(watch);
@@ -436,9 +437,6 @@ int audit_add_watch(struct audit_krule *krule, struct
 list_head **list)
 
 	audit_add_to_parent(krule, parent);
 
-	/* match get in audit_find_parent or audit_init_parent */
-	audit_put_parent(parent);
-
 	h = audit_hash_ino((u32)watch->ino);
 	*list = &audit_inode_hash[h];

error:

Signature · 2 lines
paul moore
security @ redhat
#6 lore raw

Re: [PATCH V6 2/2] audit: eliminate unnecessary extra layer of watch parent references

Quoted 24 lines · Paul Moore
Quoted 23 lines · Richard Guy Briggs

The audit watch parent count was imbalanced, adding an unnecessary layer of watch parent references. Decrement the additional parent reference when a watch is reused, already having a reference to the parent.

---
 kernel/audit_watch.c |    6 ++----
 1 files changed, 2 insertions(+), 4 deletions(-)
kernel/audit_watch.c +2 -0
index f33f54c..8f123d7 100644
@@ -391,11 +391,12 @@ static void audit_add_to_parent(struct audit_krule
 *krule,
 
 		audit_get_watch(w);
 		krule->watch = watch = w;
+
+		audit_put_parent(parent);
 		break;
 	}
 
Quoted 6 lines

kernel/audit_watch.c static void audit_add_to_parent(struct audit_krule *krule, · line 400

Quoted 3 lines
kernel/audit_watch.c +0 -1
 	if (!watch_found) {
-		audit_get_parent(parent);
 		watch->parent = parent;

I understand removing the get() here and the put() in audit_add_watch, but I don't understand adding the put() above, can you help me understand?

audit_find_parent() gets a reference to the parent, if the parent is already known. This additional parental reference is not needed if the watch is subsequently found by audit_add_to_parent(), and consumed if the watch does not already exist, so we need to put the parent if the watch is found, and do nothing if this new watch is added to the parent.

If the parent wasn't already known, it is created with a refcount of 1 and added to the audit_watch_group, then incremented by one to be subsequently consumed by the newly created watch in audit_add_to_parent().

The graph below may help to visualize it.

The rule points to the watch, not to the parent, so the rule's refcount gets bumped, not the parent's.

Quoted 4 lines
Quoted 4 lines
kernel/audit_watch.c +0 -0
 		audit_get_watch(watch);
@@ -436,9 +437,6 @@ int audit_add_watch(struct audit_krule *krule, struct
 list_head **list)
 
Quoted 8 lines
Quoted 8 lines
kernel/audit_watch.c +0 -3
 	audit_add_to_parent(krule, parent);
 
-	/* match get in audit_find_parent or audit_init_parent */
-	audit_put_parent(parent);
-
 	h = audit_hash_ino((u32)watch->ino);
 	*list = &audit_inode_hash[h];

error:

	audit_add_watch(entry->rule)
		parent = audit_find_parent()
			fsnotify_find_inode_mark(audit_watch_group)
				fsnotify_find_mark(audit_watch_group)
					fsnotify_get_mark() parent->mark->refcnt ++
		OR parent = audit_init_parent()
			fsnotify_init_mark() parent->mark->refcnt = 1
			fsnotify_add_mark(parent->mark, audit_watch_group)
				fsnotify_add_mark_locked(parent->mark, audit_watch_group)
				|	fsnotify_get_group(audit_watch_group) audit_watch_group->refcnt ++ (mark->group)
				 |	audit_watch_group->num_marks ++ (mark->g_list)
				  |	fsnotify_get_mark(parent->mark) parent->mark->refcnt ++ (i_list/m_list?)
				|	on err, fsnotify_put_group(audit_watch_group) audit_watch_group->refcnt -- test
				 |	on err, audit_watch_group->num_marks --
				  |	on err, destroy_list fsnotify_put_mark(parent->mark) parent->mark->refcnt -- test
						fsnotify_put_group(parent->mark->group) audit_watch_group->refcnt -- test
							fsnotify_final_destroy_group(audit_watch_group) group->ops->free_group_priv(group)
			on err, audit_free_parent(parent)
		on err, return err
		audit_add_to_parent(entry->rule, parent)
			if found, call audit_put_watch(entry->rule->watch) entry->rule->watch->count -- and test?
			if found, call audit_get_watch(parent->watches->watch) parent->watches->watch->count ++
+p			if found, call audit_put_parent(parent) parent->mark->refcnt --
-p			if not found, call audit_get_parent(parent) parent->mark->refcnt ++
-p		audit_put_parent(parent)
			fsnotify_put_mark(parent->mark) parent->mark->refcnt -- test
				fsnotify_put_group(parent->mark->group) audit_watch_group->refcnt -- test
					fsnotify_final_destroy_group(audit_watch_group) group->ops->free_group_priv(group)
Quoted 1 line

paul moore

- RGB

--
Richard Guy Briggs <[email protected]>
Senior Software Engineer, Kernel Security, AMER ENG Base Operating Systems, Red Hat Remote, Ottawa, Canada
Voice: +1.647.777.2635, Internal: (81) 32635, Alt: +1.613.693.0684x3545

#7 lore raw

Re: [PATCH V6 2/2] audit: eliminate unnecessary extra layer of watch parent references

Quoted 51 lines · Richard Guy Briggs
Quoted 30 lines · Paul Moore
Quoted 29 lines · Richard Guy Briggs

The audit watch parent count was imbalanced, adding an unnecessary layer of
watch parent references. Decrement the additional parent reference when a
watch is reused, already having a reference to the parent.

---

 kernel/audit_watch.c |    6 ++----
 1 files changed, 2 insertions(+), 4 deletions(-)
kernel/audit_watch.c +2 -0
index f33f54c..8f123d7 100644
@@ -391,11 +391,12 @@ static void audit_add_to_parent(struct audit_krule
 *krule,
 
 		audit_get_watch(w);
 		krule->watch = watch = w;
 
+
+		audit_put_parent(parent);
 
 		break;
 
 	}
 
Quoted 8 lines

kernel/audit_watch.c static void audit_add_to_parent(struct audit_krule *krule,

Quoted 5 lines
kernel/audit_watch.c +0 -1
 	if (!watch_found) {
 
-		audit_get_parent(parent);
 
 		watch->parent = parent;

I understand removing the get() here and the put() in audit_add_watch, but I don't understand adding the put() above, can you help me understand?

audit_find_parent() gets a reference to the parent, if the parent is already known. This additional parental reference is not needed if the watch is subsequently found by audit_add_to_parent(), and consumed if the watch does not already exist, so we need to put the parent if the watch is found, and do nothing if this new watch is added to the parent.

If the parent wasn't already known, it is created with a refcount of 1 and added to the audit_watch_group, then incremented by one to be subsequently consumed by the newly created watch in audit_add_to_parent().

Quoted 4 lines

The graph below may help to visualize it.

The rule points to the watch, not to the parent, so the rule's refcount gets bumped, not the parent's.

Great, thanks for the explanation. Fix up the goto/return in patch 1/2, resubmit and I'll merge this patchset into audit#next.

Signature · 2 lines
paul moore
security @ redhat