Skip to contentSkip to conversation

perf/x86/intel/pt: Clean up error handling in pt_event_add()

PATCH In review Ingo Molnar 3 participants 3 messages Apr 16, 2015 – Apr 18, 2015

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 perf/x86/intel/pt: Clean up error handling in pt_event_add()

Quoted 35 lines · Alexander Shishkin
Quoted 3 lines · Dan Carpenter

That's not the style that the rest of this file uses. Every function uses direct returns where possible except pt_event_add() and that function seems buggy.

Indeed.

Quoted 8 lines

arch/x86/kernel/cpu/perf_event_intel_pt.c
1000
1001 if (mode & PERF_EF_START) {
1002 pt_event_start(event, 0);
1003 if (hwc->state = PERF_HES_STOPPED) {
1004 pt_event_del(event, 0);

  1005                          ret = -EBUSY;
                                ^^^^^^^^^^^^
Quoted 8 lines

We set "ret" here but then return zero.

  1006                  }
  1007          } else {
  1008                  hwc->state = PERF_HES_STOPPED;
                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Shouldn't we set "ret" here?

No, or we'll end up returning -EBUSY where we should return zero for snapshot counters. It can be done above the quoted if statement.

How does the following look to you?

From 726515f8bbef2ca02c495695b9451533d1bc6207 Mon Sep 17 00:00:00 2001
From: Alexander Shishkin <[email protected]>
Date: Wed, 15 Apr 2015 12:56:52 +0300
Subject: [PATCH] perf/x86/intel/pt: cleanup error paths in pt_event_add()

Quoted 6 lines

pt_event_add() ends up returning 0 instead of -EBUSY in case of failure to start the newly added event. This is a result of complex handling of its return code.

This patch makes the return code handling of pt_event_add() more obvious and fixes the mentioned bug.

So it's still not obvious enough IMO - I wrote the patch below. Untested.

NOTE: I materially changed the existing clean up logic in the pt_event_start() failure case to use the direct perf_aux_output_end() path, not pt_event_del(). I could not convince myself that pt_event_del() is really needed there - but I might be wrong.

In any case, these functions are a mess and they are barely documented! Please add proper comments about what the interaction and expected rules of perf_aux_output_begin(), pt_buffer_reset_offsets(), pt_buffer_reset_markers(), pt_event_start(), perf_aux_output_end() et al is, right now it's a guessing game mostly. (in a separate patch please)

Btw., pt_event_start() has weird error handling as well: it should probably return an error code, instead of open coding event->hw.state = PERF_HES_STOPPED. This would have to be changed in all PMU drivers, with core perf setting hw.state to PERF_HES_STOPPED or so?

Thanks,

Ingo

---

 arch/x86/kernel/cpu/perf_event_intel_pt.c | 32 +++++++++++++++----------------
 1 file changed, 15 insertions(+), 17 deletions(-)
arch/x86/kernel/cpu/perf_event_intel_pt.c +15 -17
index f2770641c0fd..1b298caf09c1 100644
@@ -988,38 +988,36 @@ static int pt_event_add(struct perf_event *event, int mode)
 	int ret = -EBUSY;
 
 	if (pt->handle.event)
-		goto out;
+		goto fail;
 
 	buf = perf_aux_output_begin(&pt->handle, event);
-	if (!buf) {
-		ret = -EINVAL;
-		goto out;
-	}
+	ret = -EINVAL;
+	if (!buf)
+		goto fail_stop;
 
 	pt_buffer_reset_offsets(buf, pt->handle.head);
 	if (!buf->snapshot) {
 		ret = pt_buffer_reset_markers(buf, &pt->handle);
-		if (ret) {
-			perf_aux_output_end(&pt->handle, 0, true);
-			goto out;
-		}
+		if (ret)
+			goto fail_end_stop;
 	}
 
 	if (mode & PERF_EF_START) {
 		pt_event_start(event, 0);
-		if (hwc->state = PERF_HES_STOPPED) {
-			pt_event_del(event, 0);
-			ret = -EBUSY;
-		}
+		ret = -EBUSY;
+		if (hwc->state = PERF_HES_STOPPED)
+			goto fail_end_stop;
 	} else {
 		hwc->state = PERF_HES_STOPPED;
 	}
 
-	ret = 0;
-out:
+	return 0;
 
-	if (ret)
-		hwc->state = PERF_HES_STOPPED;
+fail_end_stop:
+	perf_aux_output_end(&pt->handle, 0, true);
+fail_stop:
+	hwc->state = PERF_HES_STOPPED;
+fail:
 
 	return ret;
 }
#1 lore raw
Quoted 9 lines · Ingo Molnar

* Alexander Shishkin <[email protected]> wrote:

So it's still not obvious enough IMO - I wrote the patch below. Untested.

NOTE: I materially changed the existing clean up logic in the pt_event_start() failure case to use the direct perf_aux_output_end() path, not pt_event_del(). I could not convince myself that pt_event_del() is really needed there - but I might be wrong.

No, you're right, perf_aux_output_end() is sufficient there.

Quoted 6 lines

In any case, these functions are a mess and they are barely documented! Please add proper comments about what the interaction and expected rules of perf_aux_output_begin(), pt_buffer_reset_offsets(), pt_buffer_reset_markers(), pt_event_start(), perf_aux_output_end() et al is, right now it's a guessing game mostly. (in a separate patch please)

Will do.

Quoted 4 lines

Btw., pt_event_start() has weird error handling as well: it should probably return an error code, instead of open coding event->hw.state = PERF_HES_STOPPED. This would have to be changed in all PMU drivers, with core perf setting hw.state to PERF_HES_STOPPED or so?

The difference is that normal performance counters can't really fail to start if their pmu::add() succeeded and afaict that such is also the assumption in the perf core; aux counters, however, can run out of room in the aux buffer. For most things tracking hw.state seems sufficient.

What I could do is have something like do_pt_event_start() that returns -ENOSPC for the buffer-full condition and call it from both pt_event_add() and pt_event_start(), which would both set hw.state to HES_STOPPED if it fails. I'm not sure how much of a readability improvement that is, I suspect that the same can be achieved by adding appropriate comments to these functions. What do you think?

Thanks,
--
Alex

#2 lore raw

[tip:perf/urgent] perf/x86/intel/pt: Fix and clean up error handling in pt_event_add()

In reply to Ingo Molnar
perf/x86/intel/pt: Fix and clean up error handling in pt_event_add()
Commit-ID:  0c99241c93b8060441f3c8434848e54b5338f922
Gitweb:     http://git.kernel.org/tip/0c99241c93b8060441f3c8434848e54b5338f922
Author:     Ingo Molnar <[email protected]>
AuthorDate: Thu, 16 Apr 2015 12:38:30 +0200
Committer:  Ingo Molnar <[email protected]>
CommitDate: Sat, 18 Apr 2015 13:31:26 +0200

perf/x86/intel/pt: Fix and clean up error handling in pt_event_add()

Dan Carpenter reported that pt_event_add() has buggy error handling logic: it returns 0 instead of -EBUSY when it fails to start a newly added event.

Furthermore, the control flow in this function is messy, with cleanup labels mixed with direct returns.

Fix the bug and clean up the code by converting it to a straight fast path for the regular non-failing case, plus a clear sequence of cascading goto labels to do all cleanup.

NOTE: I materially changed the existing clean up logic in the pt_event_start() failure case to use the direct perf_aux_output_end() path, not pt_event_del(), because perf_aux_output_end() is enough here.

---
 arch/x86/kernel/cpu/perf_event_intel_pt.c | 33 ++++++++++++++-----------------
 1 file changed, 15 insertions(+), 18 deletions(-)
arch/x86/kernel/cpu/perf_event_intel_pt.c +15 -18
index f277064..ffe666c 100644
@@ -988,39 +988,36 @@ static int pt_event_add(struct perf_event *event, int mode)
 	int ret = -EBUSY;
 
 	if (pt->handle.event)
-		goto out;
+		goto fail;
 
 	buf = perf_aux_output_begin(&pt->handle, event);
-	if (!buf) {
-		ret = -EINVAL;
-		goto out;
-	}
+	ret = -EINVAL;
+	if (!buf)
+		goto fail_stop;
 
 	pt_buffer_reset_offsets(buf, pt->handle.head);
 	if (!buf->snapshot) {
 		ret = pt_buffer_reset_markers(buf, &pt->handle);
-		if (ret) {
-			perf_aux_output_end(&pt->handle, 0, true);
-			goto out;
-		}
+		if (ret)
+			goto fail_end_stop;
 	}
 
 	if (mode & PERF_EF_START) {
 		pt_event_start(event, 0);
-		if (hwc->state == PERF_HES_STOPPED) {
-			pt_event_del(event, 0);
-			ret = -EBUSY;
-		}
+		ret = -EBUSY;
+		if (hwc->state == PERF_HES_STOPPED)
+			goto fail_end_stop;
 	} else {
 		hwc->state = PERF_HES_STOPPED;
 	}
 
-	ret = 0;
-out:
-
-	if (ret)
-		hwc->state = PERF_HES_STOPPED;
+	return 0;
 
+fail_end_stop:
+	perf_aux_output_end(&pt->handle, 0, true);
+fail_stop:
+	hwc->state = PERF_HES_STOPPED;
+fail:
 	return ret;
 }