[ PATCH 0/2] [BUGFIX] trace-cmd: Fix two small bugs

[ PATCH 0/2] [BUGFIX] trace-cmd: Fix two small bugs

[Yoshihiro YUNOMAE]

Hi Steven,

I found two small bugs for current trace-cmd, so I fixed those.
1st patch fixes the problem which listen server reader processes abort silently.
2nd patch fixes the problem which trace-cmd cannot record trace data of 
multiple buffers in old kernels.

Thank you,

---

Yoshihiro YUNOMAE (2):
      trace-cmd: [BUGFIX] Initialize handle->options list in tracecmd_attach_cpu_data_fd()
      trace-cmd: [BUGFIX] Don't die if an instance does not have 'current_tracer' file


 trace-output.c |    1 +
 trace-record.c |   12 +++++++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

-- 
Yoshihiro YUNOMAE
Software Platform Research Dept. Linux Technology Center
Hitachi, Ltd., Yokohama Research Laboratory
E-mail: yoshihiro.yunomae.ez@hitachi.com

[PATCH 1/2] trace-cmd: [BUGFIX] Initialize handle->options list in tracecmd_attach_cpu_data_fd()

[Yoshihiro YUNOMAE]

This patch initializes handle->options list in tracecmd_attach_cpu_data_fd().

When recorder sends trace data via network, server recording process is
killed by SIGSEGV from the patch 71484a0854f7. This is because add_options()
uses handle->options list from the patch, but tracecmd_attach_cpu_data_fd()
calling add_options() does not initialize the list in spite of allocation of
new handle. As the result, the server recording process will be killed because
handle->options is cleared to zero in tracecmd_attach_cpu_data_fd().

<How to test>
1. Execute network(listen) server
 # trace-cmd listen -p 12345

2. Execute network client
 # trace-cmd record -e sched* -N <server IP>:12345

3. Stop the record on client
 ^C

 Here, network server should output a line "CPUX data recorded at offset=XXXX",
 but current network server aborts silently.

 Moreover the client's per-cpu files are separated. (Normally those files
 are merged into one trace file.)

4. Confirm error on network server
 #  dmesg | tail -1
[18551.537113] trace-cmd[23073]: segfault at ffffffffffffffe8 ip 0000000000432fd1 sp 00007fffffa4caa0 error 5 in trace-cmd[400000+47000]

 After we would introduce this patch, the server will be fully able to output
 the client's tracing data and we will not get this error.

Signed-off-by: Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
---
 trace-output.c |    1 +
 1 file changed, 1 insertion(+)

diff --git a/trace-output.c b/trace-output.c
index ed81466..b033baa 100644
--- a/trace-output.c
+++ b/trace-output.c
@@ -1202,6 +1202,7 @@ int tracecmd_attach_cpu_data_fd(int fd, int cpus, char * const *cpu_data_files)
 	handle->pevent = tracecmd_get_pevent(ihandle);
 	pevent_ref(pevent);
 	handle->page_size = tracecmd_page_size(ihandle);
+	list_head_init(&handle->options);
 
 	if (tracecmd_append_cpu_data(handle, cpus, cpu_data_files) >= 0)
 		ret = 0;

Re: [PATCH 1/2] trace-cmd: [BUGFIX] Initialize handle->options list in tracecmd_attach_cpu_data_fd()

[Steven Rostedt]

On Tue, 24 Jun 2014 02:23:43 +0000
Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com> wrote:

> This patch initializes handle->options list in tracecmd_attach_cpu_data_fd().
> 
> When recorder sends trace data via network, server recording process is
> killed by SIGSEGV from the patch 71484a0854f7. This is because add_options()
> uses handle->options list from the patch, but tracecmd_attach_cpu_data_fd()
> calling add_options() does not initialize the list in spite of allocation of
> new handle. As the result, the server recording process will be killed because
> handle->options is cleared to zero in tracecmd_attach_cpu_data_fd().
> 
> <How to test>
> 1. Execute network(listen) server
>  # trace-cmd listen -p 12345
> 
> 2. Execute network client
>  # trace-cmd record -e sched* -N <server IP>:12345
> 
> 3. Stop the record on client
>  ^C
> 
>  Here, network server should output a line "CPUX data recorded at offset=XXXX",
>  but current network server aborts silently.
> 
>  Moreover the client's per-cpu files are separated. (Normally those files
>  are merged into one trace file.)
> 
> 4. Confirm error on network server
>  #  dmesg | tail -1
> [18551.537113] trace-cmd[23073]: segfault at ffffffffffffffe8 ip 0000000000432fd1 sp 00007fffffa4caa0 error 5 in trace-cmd[400000+47000]
> 
>  After we would introduce this patch, the server will be fully able to output
>  the client's tracing data and we will not get this error.
> 
> Signed-off-by: Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com>
> Cc: Steven Rostedt <rostedt@goodmis.org>

Applied thanks! I also added a test to my trace-cmd test suite to check
trace-cmd listen.

-- Steve


> ---
>  trace-output.c |    1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/trace-output.c b/trace-output.c
> index ed81466..b033baa 100644
> --- a/trace-output.c
> +++ b/trace-output.c
> @@ -1202,6 +1202,7 @@ int tracecmd_attach_cpu_data_fd(int fd, int cpus, char * const *cpu_data_files)
>  	handle->pevent = tracecmd_get_pevent(ihandle);
>  	pevent_ref(pevent);
>  	handle->page_size = tracecmd_page_size(ihandle);
> +	list_head_init(&handle->options);
>  
>  	if (tracecmd_append_cpu_data(handle, cpus, cpu_data_files) >= 0)
>  		ret = 0;

[PATCH 2/2] trace-cmd: [BUGFIX] Don't die if an instance does not have 'current_tracer' file

[Yoshihiro YUNOMAE]

Current trace-cmd requires 'current_tracer' file for an instance, and if
the file is nothing, trace-cmd dies. However, current_tracer file was
introduced from 607e2ea167e patch in Linux kernel 3.14-rc3, so current
trace-cmd cannot use multiple buffers for old kernels.

This patch avoids to die if current_tracer file is nothing in an instance
and the plugin name is "nop". This is because old kernels always trace
as nop mode in an instance.

<How to test>
1) # ./trace-cmd record -B foo -e sched

Before introducing this patch, following error message is output in an old
kernel:

 trace-cmd: Permission denied
   writing to '/sys/kernel/debug/tracing/instances/foo/current_tracer'

trace-cmd dies in disable_trace() calling set_plugin("nop").
After introducing this patch, trace-cmd works fine in both old kernels and
current kernel.

2) # ./trace-cmd record -B foo -e sched -p nop

It also works fine after introducing this patch in both old kernels and current
kernel.

3) # ./trace-cmd record -B foo -e sched -p function

For old kernels, it dies because an user should not set plugin tracer.
For current kernel, it works fine.

Note that this patch was tested for kernel 3.11.9-200 and 3.15.0-rc2+.

Signed-off-by: Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
---
 trace-record.c |   12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/trace-record.c b/trace-record.c
index d3dd0c5..1912175 100644
--- a/trace-record.c
+++ b/trace-record.c
@@ -890,8 +890,18 @@ set_plugin_instance(struct buffer_instance *instance, const char *name)
 
 	path = get_instance_file(instance, "current_tracer");
 	fp = fopen(path, "w");
-	if (!fp)
+	if (!fp) {
+		/*
+		 * Legacy kernels do not have current_tracer file, and they
+		 * always use nop. So, it doesn't need to try to change the
+		 * plugin for those if name is "nop".
+		 */
+		if (!strncmp(name, "nop", 3)) {
+			tracecmd_put_tracing_file(path);
+			return;
+		}
 		die("writing to '%s'", path);
+	}
 	tracecmd_put_tracing_file(path);
 
 	fwrite(name, 1, strlen(name), fp);

Re: [PATCH 2/2] trace-cmd: [BUGFIX] Don't die if an instance does not have 'current_tracer' file

[Steven Rostedt]

On Tue, 24 Jun 2014 02:23:45 +0000
Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com> wrote:

> Current trace-cmd requires 'current_tracer' file for an instance, and if
> the file is nothing, trace-cmd dies. However, current_tracer file was
> introduced from 607e2ea167e patch in Linux kernel 3.14-rc3, so current
> trace-cmd cannot use multiple buffers for old kernels.
> 
> This patch avoids to die if current_tracer file is nothing in an instance
> and the plugin name is "nop". This is because old kernels always trace
> as nop mode in an instance.
> 
> <How to test>
> 1) # ./trace-cmd record -B foo -e sched
> 
> Before introducing this patch, following error message is output in an old
> kernel:
> 
>  trace-cmd: Permission denied
>    writing to '/sys/kernel/debug/tracing/instances/foo/current_tracer'
> 
> trace-cmd dies in disable_trace() calling set_plugin("nop").
> After introducing this patch, trace-cmd works fine in both old kernels and
> current kernel.
> 
> 2) # ./trace-cmd record -B foo -e sched -p nop
> 
> It also works fine after introducing this patch in both old kernels and current
> kernel.
> 
> 3) # ./trace-cmd record -B foo -e sched -p function
> 
> For old kernels, it dies because an user should not set plugin tracer.
> For current kernel, it works fine.
> 
> Note that this patch was tested for kernel 3.11.9-200 and 3.15.0-rc2+.
> 
> Signed-off-by: Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com>
> Cc: Steven Rostedt <rostedt@goodmis.org>

Applied, thanks!

-- Steve