Skip to contentSkip to conversation

perf: add support for logging debug messages to file

PATCH Superseded Changbin Du 3 participants 8 messages Nov 25, 2019 – Nov 26, 2019 perf events

v6 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

v6 cover perf: add support for logging debug messages to file

When in TUI mode, it is impossible to show all the debug messages to console. This make it hard to debug perf issues using debug messages. This patch adds support for logging debug messages to file to resolve this problem.

v6:
o rebase to perf/core.
v5:
o doc default log path.
v4:
o fix another segfault.
v3:
o fix a segfault issue.
v2:
o specific all debug options one time.

Changbin Du (2):
perf: support multiple debug options separated by ','
perf: add support for logging debug messages to file

 tools/perf/Documentation/perf.txt |  20 +++--
 tools/perf/util/debug.c           | 127 ++++++++++++++++++++----------
 2 files changed, 96 insertions(+), 51 deletions(-)
Signature · 1 line
2.20.1
#1 lore raw

PATCH v6 1/2 perf: support multiple debug options separated by ','

This patch adds support for multiple debug options separated by ',' and non-int values.
--debug verbose=2,stderr

---
 tools/perf/Documentation/perf.txt | 13 +++--
 tools/perf/util/debug.c           | 89 ++++++++++++++++---------------
 2 files changed, 53 insertions(+), 49 deletions(-)
tools/perf/Documentation/perf.txt +6 -7
index 3f37ded13f8c..fd8d790f68a7 100644
@@ -19,13 +19,12 @@ OPTIONS
 	  --debug verbose=2 # sets verbose = 2
 
 	List of debug variables allowed to set:
-	  verbose          - general debug messages
-	  ordered-events   - ordered events object debug messages
-	  data-convert     - data convert command debug messages
-	  stderr           - write debug output (option -v) to stderr
-	                     in browser mode
-	  perf-event-open  - Print perf_event_open() arguments and
-			     return value
+	  verbose=level		- general debug messages
+	  ordered-events=level	- ordered events object debug messages
+	  data-convert=level	- data convert command debug messages
+	  stderr		- write debug output (option -v) to stderr
+	  perf-event-open	- Print perf_event_open() arguments and
+	                          return value in browser mode
 
 --buildid-dir::
 	Setup buildid cache directory. It has higher priority than
tools/perf/util/debug.c +47 -42

116 lines not on this page · raw message

Signature · 1 line
2.20.1
#2 lore raw

Re: [PATCH v6 1/2] perf: support multiple debug options separated by ','

Quoted 4 lines · Changbin Du

List of debug variables allowed to set:

tools/perf/Documentation/perf.txt +0 -3
-	  verbose          - general debug messages
-	  ordered-events   - ordered events object debug messages
-	  data-convert     - data convert command debug messages

tools/perf/Documentation/perf.txt OPTIONS · line 27

Quoted 10 lines
tools/perf/Documentation/perf.txt +6 -4
-	  stderr           - write debug output (option -v) to stderr
-	                     in browser mode
-	  perf-event-open  - Print perf_event_open() arguments and
-			     return value
+	  verbose=level		- general debug messages
+	  ordered-events=level	- ordered events object debug messages
+	  data-convert=level	- data convert command debug messages
+	  stderr		- write debug output (option -v) to stderr
+	  perf-event-open	- Print perf_event_open() arguments and
+	                          return value in browser mode

Shouldn't this be:

stderr - write debug output (option -v) to stderr
in browser mode
perf-event-open - Print perf_event_open() arguments and
return value

-Ravi

#3 lore raw

Re: [PATCH v6 1/2] perf: support multiple debug options separated by ','

Quoted 19 lines · Ravi Bangoria
Quoted 4 lines · Changbin Du

List of debug variables allowed to set:

tools/perf/Documentation/perf.txt +0 -3
-	  verbose          - general debug messages
-	  ordered-events   - ordered events object debug messages
-	  data-convert     - data convert command debug messages

tools/perf/Documentation/perf.txt OPTIONS · line 27

Quoted 10 lines
tools/perf/Documentation/perf.txt +6 -4
-	  stderr           - write debug output (option -v) to stderr
-	                     in browser mode
-	  perf-event-open  - Print perf_event_open() arguments and
-			     return value
+	  verbose=level		- general debug messages
+	  ordered-events=level	- ordered events object debug messages
+	  data-convert=level	- data convert command debug messages
+	  stderr		- write debug output (option -v) to stderr
+	  perf-event-open	- Print perf_event_open() arguments and
+	                          return value in browser mode

Shouldn't this be:

Quoted 5 lines

stderr - write debug output (option -v) to stderr
in browser mode
perf-event-open - Print perf_event_open() arguments and
return value

This is an accident when rebasing. Thank you.

Quoted 2 lines

-Ravi

Signature · 2 lines
Cheers,
Changbin Du
#4 lore raw

Re: [PATCH v6 1/2] perf: support multiple debug options separated by ','

In reply to Changbin Du
Quoted 21 lines · Changbin Du

This patch adds support for multiple debug options separated by ',' and non-int values.
--debug verbose=2,stderr

---
 tools/perf/Documentation/perf.txt | 13 +++--
 tools/perf/util/debug.c           | 89 ++++++++++++++++---------------
 2 files changed, 53 insertions(+), 49 deletions(-)
tools/perf/Documentation/perf.txt +0 -3
index 3f37ded13f8c..fd8d790f68a7 100644
@@ -19,13 +19,12 @@ OPTIONS
 	  --debug verbose=2 # sets verbose = 2
 
 	List of debug variables allowed to set:
-	  verbose          - general debug messages
-	  ordered-events   - ordered events object debug messages
-	  data-convert     - data convert command debug messages

tools/perf/Documentation/perf.txt OPTIONS · line 27

Quoted 10 lines
tools/perf/Documentation/perf.txt +6 -4
-	  stderr           - write debug output (option -v) to stderr
-	                     in browser mode
-	  perf-event-open  - Print perf_event_open() arguments and
-			     return value
+	  verbose=level		- general debug messages
+	  ordered-events=level	- ordered events object debug messages
+	  data-convert=level	- data convert command debug messages
+	  stderr		- write debug output (option -v) to stderr
+	  perf-event-open	- Print perf_event_open() arguments and
+	                          return value in browser mode

it's just the list and the doc says user can use values there, so no need for the '=level' there

also we allow this:
perf --debug stderr=9 record ls

so I thinks we should keep it general in documentation, eventhough it will always mean just stderr=true for any value

jirka

#5 lore raw

Re: [PATCH v6 1/2] perf: support multiple debug options separated by ','

Quoted 36 lines · Jiri Olsa
Quoted 21 lines · Changbin Du

This patch adds support for multiple debug options separated by ',' and non-int values.
--debug verbose=2,stderr

---
 tools/perf/Documentation/perf.txt | 13 +++--
 tools/perf/util/debug.c           | 89 ++++++++++++++++---------------
 2 files changed, 53 insertions(+), 49 deletions(-)
tools/perf/Documentation/perf.txt +0 -3
index 3f37ded13f8c..fd8d790f68a7 100644
@@ -19,13 +19,12 @@ OPTIONS
 	  --debug verbose=2 # sets verbose = 2
 
 	List of debug variables allowed to set:
-	  verbose          - general debug messages
-	  ordered-events   - ordered events object debug messages
-	  data-convert     - data convert command debug messages

tools/perf/Documentation/perf.txt OPTIONS · line 27

Quoted 10 lines
tools/perf/Documentation/perf.txt +6 -4
-	  stderr           - write debug output (option -v) to stderr
-	                     in browser mode
-	  perf-event-open  - Print perf_event_open() arguments and
-			     return value
+	  verbose=level		- general debug messages
+	  ordered-events=level	- ordered events object debug messages
+	  data-convert=level	- data convert command debug messages
+	  stderr		- write debug output (option -v) to stderr
+	  perf-event-open	- Print perf_event_open() arguments and
+	                          return value in browser mode

it's just the list and the doc says user can use values there, so no need for the '=level' there

Quoted 7 lines

also we allow this:
perf --debug stderr=9 record ls

so I thinks we should keep it general in documentation, eventhough it will always mean just stderr=true for any value

I changed them as below. For stderr and perf_event_open, the value is ignored even it is given.

--debug::
Setup debug variable (see list below). The range of 'level' value is (0, 10). Use like:
--debug verbose # sets verbose = 1
--debug verbose=2,file=~/perf.log
# sets verbose = 2 and save log to file

List of debug variables allowed to set:
verbose[=level] - general debug messages
ordered-events[=level]- ordered events object debug messages
data-convert[=level] - data convert command debug messages
stderr - write debug output (option -v) to stderr
in browser mode
perf-event-open - Print perf_event_open() arguments and
return value

Quoted 2 lines

jirka

Signature · 2 lines
Cheers,
Changbin Du
#6 lore raw

PATCH v6 2/2 perf: add support for logging debug messages to file

In reply to Changbin Du

When in TUI mode, it is impossible to show all the debug messages to console. This make it hard to debug perf issues using debug messages. This patch adds support for logging debug messages to file to resolve this problem.

The usage is:
perf -debug verbose=2,file=~/perf.log COMMAND

---
v5: doc default log path.
v4: fix another segfault.
v3: fix a segfault issue.

---
 tools/perf/Documentation/perf.txt | 15 +++++++----
 tools/perf/util/debug.c           | 44 ++++++++++++++++++++++++++++---
 2 files changed, 50 insertions(+), 9 deletions(-)
tools/perf/Documentation/perf.txt +10 -5
index fd8d790f68a7..a47933b53fbe 100644
@@ -16,15 +16,20 @@ OPTIONS
 	Setup debug variable (see list below) in value
 	range (0, 10). Use like:
 	  --debug verbose   # sets verbose = 1
-	  --debug verbose=2 # sets verbose = 2
+	  --debug verbose=2,file=~/perf.log
+	                    # sets verbose = 2 and save log to file
 
 	List of debug variables allowed to set:
-	  verbose=level		- general debug messages
-	  ordered-events=level	- ordered events object debug messages
-	  data-convert=level	- data convert command debug messages
-	  stderr		- write debug output (option -v) to stderr
+	  verbose=level         - general debug messages
+	  ordered-events=level  - ordered events object debug messages
+	  data-convert=level    - data convert command debug messages
+	  stderr                - write debug output (option -v) to stderr
+	                          in browser mode
 	  perf-event-open	- Print perf_event_open() arguments and
 	                          return value in browser mode
+	  file[=path]           - write debug output to log file, default
+	                          'perf.log' (stderr and file options are
+	                          exclusive)
 
 --buildid-dir::
 	Setup buildid cache directory. It has higher priority than
tools/perf/util/debug.c +40 -4

77 lines not on this page · raw message

Signature · 1 line
2.20.1
#7 lore raw
Quoted 31 lines · Changbin Du

When in TUI mode, it is impossible to show all the debug messages to console. This make it hard to debug perf issues using debug messages. This patch adds support for logging debug messages to file to resolve this problem.

The usage is:
perf -debug verbose=2,file=~/perf.log COMMAND

---
v5: doc default log path.
v4: fix another segfault.
v3: fix a segfault issue.

---
 tools/perf/Documentation/perf.txt | 15 +++++++----
 tools/perf/util/debug.c           | 44 ++++++++++++++++++++++++++++---
 2 files changed, 50 insertions(+), 9 deletions(-)
tools/perf/Documentation/perf.txt +2 -1
index fd8d790f68a7..a47933b53fbe 100644
@@ -16,15 +16,20 @@ OPTIONS
 	Setup debug variable (see list below) in value
 	range (0, 10). Use like:
 	  --debug verbose   # sets verbose = 1
-	  --debug verbose=2 # sets verbose = 2
+	  --debug verbose=2,file=~/perf.log
+	                    # sets verbose = 2 and save log to file
 

tools/perf/Documentation/perf.txt OPTIONS · line 27

Quoted 10 lines
tools/perf/Documentation/perf.txt +5 -4
 	List of debug variables allowed to set:
-	  verbose=level		- general debug messages
-	  ordered-events=level	- ordered events object debug messages
-	  data-convert=level	- data convert command debug messages
-	  stderr		- write debug output (option -v) to stderr
+	  verbose=level         - general debug messages
+	  ordered-events=level  - ordered events object debug messages
+	  data-convert=level    - data convert command debug messages
+	  stderr                - write debug output (option -v) to stderr
+	                          in browser mode

hum, why is this changed in this patch?

jirka

Quoted 97 lines
tools/perf/Documentation/perf.txt +3 -0
 	  perf-event-open	- Print perf_event_open() arguments and
 	                          return value in browser mode
+	  file[=path]           - write debug output to log file, default
+	                          'perf.log' (stderr and file options are
+	                          exclusive)
 
 --buildid-dir::
 	Setup buildid cache directory. It has higher priority than
tools/perf/util/debug.c +40 -4
index 929da46ece92..21bc889976bc 100644
@@ -6,6 +6,7 @@
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <errno.h>
 #include <sys/wait.h>
 #include <api/debug.h>
 #include <linux/kernel.h>
@@ -27,7 +28,7 @@ int verbose;
 int debug_peo_args;
 bool dump_trace = false, quiet = false;
 int debug_ordered_events;
-static bool redirect_to_stderr;
+static FILE *log_file;
 int debug_data_convert;
 
 int veprintf(int level, int var, const char *fmt, va_list args)
@@ -35,8 +36,10 @@ int veprintf(int level, int var, const char *fmt, va_list args)
 	int ret = 0;
 
 	if (var >= level) {
-		if (use_browser >= 1 && !redirect_to_stderr)
+		if (use_browser >= 1 && !log_file)
 			ui_helpline__vshow(fmt, args);
+		else if (log_file)
+			ret = vfprintf(log_file, fmt, args);
 		else
 			ret = vfprintf(stderr, fmt, args);
 	}
@@ -198,6 +201,24 @@ static int str2loglevel(const char *vstr)
 	return v;
 }
 
+static void flush_log(void)
+{
+	if (log_file)
+		fflush(log_file);
+}
+
+static void set_log_output(FILE *f)
+{
+	if (f == log_file)
+		return;
+
+	if (log_file && log_file != stderr)
+		fclose(log_file);
+
+	log_file = f;
+	atexit(flush_log);
+}
+
 int perf_debug_option(const char *str)
 {
 	char *sep, *vstr;
@@ -219,10 +240,25 @@ int perf_debug_option(const char *str)
 		else if (!strcmp(opt, "data-convert"))
 			debug_data_convert = str2loglevel(vstr);
 		else if (!strcmp(opt, "stderr"))
-			redirect_to_stderr = true;
+			set_log_output(stderr);
 		else if (!strcmp(opt, "perf-event-open"))
 			debug_peo_args = true;
-		else {
+		else if (!strcmp(opt, "file")) {
+			FILE *f;
+
+			if (!vstr)
+				vstr = (char *)"perf.log";
+
+			f = fopen(vstr, "a");
+			if (!f) {
+				pr_err("Can not create log file: %s\n",
+				       strerror(errno));
+				free(dstr);
+				return -1;
+			}
+			fprintf(f, "\n===========perf log===========\n");
+			set_log_output(f);
+		} else {
 			fprintf(stderr, "unkown debug option '%s'\n", opt);
 			free(dstr);
 			return -1;
Signature · 1 line
2.20.1