Skip to contentSkip to conversation

perf ftrace: Detect whether ftrace is enabled on system

PATCH In review Changbin Du 3 participants 4 messages Sep 11, 2024 – Sep 12, 2024 perf events

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 perf ftrace: Detect whether ftrace is enabled on system

To make error messages more accurate, this change detects whether ftrace is enabled on system by checking trace file "set_ftrace_pid".

Before:
~ # perf ftrace
failed to reset ftrace

After:
~ # perf ftrace
ftrace is not supported on this system

v2: rebase on perf-tools-next.

---
 tools/perf/builtin-ftrace.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
tools/perf/builtin-ftrace.c +23 -0
index 88a87bf387d2..abcdc49b7a98 100644
@@ -80,6 +80,24 @@ static bool check_ftrace_capable(void)
 	return false;
 }
 
+static bool is_ftrace_supported(void)
+{
+	char *file;
+	bool supported = false;
+
+	file = get_tracing_file("set_ftrace_pid");
+	if (!file) {
+		pr_debug("cannot get tracing file set_ftrace_pid\n");
+		return false;
+	}
+
+	if (!access(file, F_OK))
+		supported = true;
+
+	put_tracing_file(file);
+	return supported;
+}
+
 static int __write_tracing_file(const char *name, const char *val, bool append)
 {
 	char *file;
@@ -1583,6 +1601,11 @@ int cmd_ftrace(int argc, const char **argv)
 	if (!check_ftrace_capable())
 		return -1;
 
+	if (!is_ftrace_supported()) {
+		pr_err("ftrace is not supported on this system\n");
+		return -ENOTSUP;
+	}
+
 	ret = perf_config(perf_ftrace_config, &ftrace);
 	if (ret < 0)
 		return -1;
Signature · 1 line
2.34.1
reviewer Reviewed-by on v2 1/1
#1 lore raw
Quoted 49 lines · Changbin Du

To make error messages more accurate, this change detects whether ftrace is enabled on system by checking trace file "set_ftrace_pid".

Before:
~ # perf ftrace
failed to reset ftrace

After:
~ # perf ftrace
ftrace is not supported on this system

v2: rebase on perf-tools-next.

---
  tools/perf/builtin-ftrace.c | 23 +++++++++++++++++++++++
  1 file changed, 23 insertions(+)
tools/perf/builtin-ftrace.c +18 -0
index 88a87bf387d2..abcdc49b7a98 100644
@@ -80,6 +80,24 @@ static bool check_ftrace_capable(void)
  	return false;
  }
 
+static bool is_ftrace_supported(void)
+{
+	char *file;
+	bool supported = false;
+
+	file = get_tracing_file("set_ftrace_pid");
+	if (!file) {
+		pr_debug("cannot get tracing file set_ftrace_pid\n");
+		return false;
+	}
+
+	if (!access(file, F_OK))
+		supported = true;
+
+	put_tracing_file(file);
+	return supported;
+}
+
  static int __write_tracing_file(const char *name, const char *val, bool append)
  {
  	char *file;
@@ -1583,6 +1601,11 @@ int cmd_ftrace(int argc, const char **argv)
  	if (!check_ftrace_capable())

tools/perf/builtin-ftrace.c int cmd_ftrace(int argc, const char **argv) · line 1611

Quoted 10 lines
tools/perf/builtin-ftrace.c +5 -0
  		return -1;
 
+	if (!is_ftrace_supported()) {
+		pr_err("ftrace is not supported on this system\n");
+		return -ENOTSUP;
+	}
+
  	ret = perf_config(perf_ftrace_config, &ftrace);
  	if (ret < 0)
  		return -1;
maintainer Reviewed-by James Clark Tested-by
#2 lore raw
Quoted 3 lines · James Clark
Quoted 2 lines · Changbin Du

To make error messages more accurate, this change detects whether ftrace is enabled on system by checking trace file "set_ftrace_pid".

<SNIP>

Quoted 5 lines
Quoted 5 lines
tools/perf/builtin-ftrace.c +2 -0
@@ -1583,6 +1601,11 @@ int cmd_ftrace(int argc, const char **argv)
  	if (!check_ftrace_capable())
  		return -1;
+	if (!is_ftrace_supported()) {
+		pr_err("ftrace is not supported on this system\n");
Quoted 8 lines

tools/perf/builtin-ftrace.c int cmd_ftrace(int argc, const char **argv) · line 1611

Quoted 6 lines
tools/perf/builtin-ftrace.c +3 -0
+		return -ENOTSUP;
+	}
+
  	ret = perf_config(perf_ftrace_config, &ftrace);
  	if (ret < 0)
  		return -1;

Applied and added these comments:

Committer testing:

Doing it in an unprivileged toolbox container on Fedora 40:

Before:

  acme@number:~/git/perf-tools-next$ toolbox enter perf
  ⬢[acme@toolbox perf-tools-next]$ sudo su -
  ⬢[root@toolbox ~]# ~acme/bin/perf ftrace
  failed to reset ftrace
  ⬢[root@toolbox ~]#

After this patch:

⬢[root@toolbox ~]# ~acme/bin/perf ftrace
ftrace is not supported on this system
⬢[root@toolbox ~]#

Maybe we could check if we are in such as situation, inside an unprivileged container, and provide a HINT line?

author
#3 lore raw
Quoted 35 lines · Arnaldo Carvalho de Melo
Quoted 3 lines · James Clark
Quoted 2 lines · Changbin Du

To make error messages more accurate, this change detects whether ftrace is enabled on system by checking trace file "set_ftrace_pid".

<SNIP>

Quoted 5 lines
Quoted 5 lines
tools/perf/builtin-ftrace.c +2 -0
@@ -1583,6 +1601,11 @@ int cmd_ftrace(int argc, const char **argv)
  	if (!check_ftrace_capable())
  		return -1;
+	if (!is_ftrace_supported()) {
+		pr_err("ftrace is not supported on this system\n");
Quoted 8 lines

tools/perf/builtin-ftrace.c int cmd_ftrace(int argc, const char **argv) · line 1611

Quoted 6 lines
tools/perf/builtin-ftrace.c +3 -0
+		return -ENOTSUP;
+	}
+
  	ret = perf_config(perf_ftrace_config, &ftrace);
  	if (ret < 0)
  		return -1;

Applied and added these comments:

Committer testing:

Doing it in an unprivileged toolbox container on Fedora 40:

Before:

  acme@number:~/git/perf-tools-next$ toolbox enter perf
  ⬢[acme@toolbox perf-tools-next]$ sudo su -
  ⬢[root@toolbox ~]# ~acme/bin/perf ftrace
  failed to reset ftrace
  ⬢[root@toolbox ~]#
Quoted 9 lines

After this patch:

⬢[root@toolbox ~]# ~acme/bin/perf ftrace
ftrace is not supported on this system
⬢[root@toolbox ~]#

Maybe we could check if we are in such as situation, inside an unprivileged container, and provide a HINT line?

I think we could check the mount status of tracefs first, and then check whether the ftrace node exists. If there's a permission issue in container, maybe we should also check the errno of access().

Quoted 3 lines
Signature · 2 lines
Cheers,
Changbin Du