2009-12-24 01:40:32

by KOSAKI Motohiro

[permalink] [raw]
Subject: [PATCH] kprobetrace: documentation fix


shell interpret $val is as shell variable. thus we need quote if
we use echo command.

Signed-off-by: KOSAKI Motohiro <[email protected]>
Cc: Masami Hiramatsu <[email protected]>
---
Documentation/trace/kprobetrace.txt | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/trace/kprobetrace.txt b/Documentation/trace/kprobetrace.txt
index 47aabee..2be6e19 100644
--- a/Documentation/trace/kprobetrace.txt
+++ b/Documentation/trace/kprobetrace.txt
@@ -82,13 +82,13 @@ Usage examples
To add a probe as a new event, write a new definition to kprobe_events
as below.

- echo p:myprobe do_sys_open dfd=$arg0 filename=$arg1 flags=$arg2 mode=$arg3 > /sys/kernel/debug/tracing/kprobe_events
+ echo 'p:myprobe do_sys_open dfd=$arg0 filename=$arg1 flags=$arg2 mode=$arg3' > /sys/kernel/debug/tracing/kprobe_events

This sets a kprobe on the top of do_sys_open() function with recording
1st to 4th arguments as "myprobe" event. As this example shows, users can
choose more familiar names for each arguments.

- echo r:myretprobe do_sys_open $retval >> /sys/kernel/debug/tracing/kprobe_events
+ echo 'r:myretprobe do_sys_open $retval' >> /sys/kernel/debug/tracing/kprobe_events

This sets a kretprobe on the return point of do_sys_open() function with
recording return value as "myretprobe" event.
--
1.6.5.2



2009-12-24 02:09:09

by KOSAKI Motohiro

[permalink] [raw]
Subject: [PATCH] doc: kprobetrace: Add the explanation to remove probe points

Latest kprobetrace can remove probe points selectively. thus
documentation should be updated too.

Signed-off-by: KOSAKI Motohiro <[email protected]>
Cc: Masami Hiramatsu <[email protected]>
---
Documentation/trace/kprobetrace.txt | 7 +++++++
1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/Documentation/trace/kprobetrace.txt b/Documentation/trace/kprobetrace.txt
index 2be6e19..8c88930 100644
--- a/Documentation/trace/kprobetrace.txt
+++ b/Documentation/trace/kprobetrace.txt
@@ -24,6 +24,7 @@ Synopsis of kprobe_events
-------------------------
p[:[GRP/]EVENT] SYMBOL[+offs]|MEMADDR [FETCHARGS] : Set a probe
r[:[GRP/]EVENT] SYMBOL[+0] [FETCHARGS] : Set a return probe
+ -:[GRP/]EVENT : Clear a probe

GRP : Group name. If omitted, use "kprobes" for it.
EVENT : Event name. If omitted, the event name is generated
@@ -121,6 +122,12 @@ print fmt: "(%lx) dfd=%lx filename=%lx flags=%lx mode=%lx", REC->ip, REC->dfd, R

This clears all probe points.

+ Or,
+
+ echo -:myprobe >> kprobe_events
+
+ This clears probe points selectively.
+
Right after definition, each event is disabled by default. For tracing these
events, you need to enable it.

--
1.6.5.2


2009-12-26 04:04:31

by Masami Hiramatsu

[permalink] [raw]
Subject: Re: [PATCH] kprobetrace: documentation fix

KOSAKI Motohiro wrote:
>
> shell interpret $val is as shell variable. thus we need quote if
> we use echo command.

Right.
Thank you for fixing!

> Signed-off-by: KOSAKI Motohiro <[email protected]>

Acked-by: Masami Hiramatsu <[email protected]>

> ---
> Documentation/trace/kprobetrace.txt | 4 ++--
> 1 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/trace/kprobetrace.txt b/Documentation/trace/kprobetrace.txt
> index 47aabee..2be6e19 100644
> --- a/Documentation/trace/kprobetrace.txt
> +++ b/Documentation/trace/kprobetrace.txt
> @@ -82,13 +82,13 @@ Usage examples
> To add a probe as a new event, write a new definition to kprobe_events
> as below.
>
> - echo p:myprobe do_sys_open dfd=$arg0 filename=$arg1 flags=$arg2 mode=$arg3 > /sys/kernel/debug/tracing/kprobe_events
> + echo 'p:myprobe do_sys_open dfd=$arg0 filename=$arg1 flags=$arg2 mode=$arg3' > /sys/kernel/debug/tracing/kprobe_events
>
> This sets a kprobe on the top of do_sys_open() function with recording
> 1st to 4th arguments as "myprobe" event. As this example shows, users can
> choose more familiar names for each arguments.
>
> - echo r:myretprobe do_sys_open $retval >> /sys/kernel/debug/tracing/kprobe_events
> + echo 'r:myretprobe do_sys_open $retval' >> /sys/kernel/debug/tracing/kprobe_events
>
> This sets a kretprobe on the return point of do_sys_open() function with
> recording return value as "myretprobe" event.

--
Masami Hiramatsu

Software Engineer
Hitachi Computer Products (America), Inc.
Software Solutions Division

e-mail: [email protected]

2009-12-26 04:06:14

by Masami Hiramatsu

[permalink] [raw]
Subject: Re: [PATCH] doc: kprobetrace: Add the explanation to remove probe points

KOSAKI Motohiro wrote:
> Latest kprobetrace can remove probe points selectively. thus
> documentation should be updated too.

Ah, right.

>
> Signed-off-by: KOSAKI Motohiro <[email protected]>

Acked-by: Masami Hiramatsu <[email protected]>

Thank you very much!

> Cc: Masami Hiramatsu <[email protected]>
> ---
> Documentation/trace/kprobetrace.txt | 7 +++++++
> 1 files changed, 7 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/trace/kprobetrace.txt b/Documentation/trace/kprobetrace.txt
> index 2be6e19..8c88930 100644
> --- a/Documentation/trace/kprobetrace.txt
> +++ b/Documentation/trace/kprobetrace.txt
> @@ -24,6 +24,7 @@ Synopsis of kprobe_events
> -------------------------
> p[:[GRP/]EVENT] SYMBOL[+offs]|MEMADDR [FETCHARGS] : Set a probe
> r[:[GRP/]EVENT] SYMBOL[+0] [FETCHARGS] : Set a return probe
> + -:[GRP/]EVENT : Clear a probe
>
> GRP : Group name. If omitted, use "kprobes" for it.
> EVENT : Event name. If omitted, the event name is generated
> @@ -121,6 +122,12 @@ print fmt: "(%lx) dfd=%lx filename=%lx flags=%lx mode=%lx", REC->ip, REC->dfd, R
>
> This clears all probe points.
>
> + Or,
> +
> + echo -:myprobe >> kprobe_events
> +
> + This clears probe points selectively.
> +
> Right after definition, each event is disabled by default. For tracing these
> events, you need to enable it.
>

--
Masami Hiramatsu

Software Engineer
Hitachi Computer Products (America), Inc.
Software Solutions Division

e-mail: [email protected]