Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36;
MIME-Version: 1.0
References: <20231212192317.0fb6b101@gandalf.local.home>
In-Reply-To: <20231212192317.0fb6b101@gandalf.local.home>
From:   Alexander Kapshuk <alexander.kapshuk@gmail.com>
Date:   Wed, 13 Dec 2023 10:09:50 +0200
Message-ID: <CAJ1xhMXuxGHfD8oRfbna_drpHmNv0RUXFrvuVv6rtt-KeCM9fQ@mail.gmail.com>
Subject: Re: [PATCH v3] tracing/selftests: Add test to test the trace_marker
To:     Steven Rostedt <rostedt@goodmis.org>
Cc:     LKML <linux-kernel@vger.kernel.org>,
        Linux Trace Kernel <linux-trace-kernel@vger.kernel.org>,
        Masami Hiramatsu <mhiramat@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
        Shuah Khan <shuah@kernel.org>, linux-kselftest@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

The REs used in the sed commands below may be simplified as shown if desire=
d.

On Wed, Dec 13, 2023 at 2:22=E2=80=AFAM Steven Rostedt <rostedt@goodmis.org=
> wrote:
>
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
>
> Add a test that writes longs strings, some over the size of the sub buffe=
r
> and make sure that the entire content is there.
>
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> ---
> Changes since v2: https://lore.kernel.org/linux-trace-kernel/202312121516=
32.25c9b67d@gandalf.local.home
>
> - Realized with the upcoming change of the dynamic subbuffer sizes, that
>   this test will fail if the subbuffer is bigger than what the trace_seq
>   can hold. Now the trace_marker does not always utilize the full subbuff=
er
>   but the size of the trace_seq instead. As that size isn't available to
>   user space, we can only just make sure all content is there.
>
>  .../ftrace/test.d/00basic/trace_marker.tc     | 82 +++++++++++++++++++
>  1 file changed, 82 insertions(+)
>  create mode 100755 tools/testing/selftests/ftrace/test.d/00basic/trace_m=
arker.tc
>
> diff --git a/tools/testing/selftests/ftrace/test.d/00basic/trace_marker.t=
c b/tools/testing/selftests/ftrace/test.d/00basic/trace_marker.tc
> new file mode 100755
> index 000000000000..b24aff5807df
> --- /dev/null
> +++ b/tools/testing/selftests/ftrace/test.d/00basic/trace_marker.tc
> @@ -0,0 +1,82 @@
> +#!/bin/sh
> +# SPDX-License-Identifier: GPL-2.0
> +# description: Basic tests on writing to trace_marker
> +# requires: trace_marker
> +# flags: instance
> +
> +get_buffer_data_size() {
> +       sed -ne 's/^.*data.*size:\([0-9][0-9]*\).*/\1/p' events/header_pa=
ge
            sed -n 's!.*data.*size:\([^;]*\).*!\1!p' events/header_page
> +}
> +
> +get_buffer_data_offset() {
> +       sed -ne 's/^.*data.*offset:\([0-9][0-9]*\).*/\1/p' events/header_=
page
            sed -n 's!.*data.*offset:\([^;]*\).*!\1!p' events/header_page
> +}
> +
> +get_event_header_size() {
> +       type_len=3D`sed -ne 's/^.*type_len.*:[^0-9]*\([0-9][0-9]*\).*/\1/=
p' events/header_event`
            type_len=3D`sed -n '/type_len.*bits/s![^0-9]*!!gp'
events/header_event`

> +       time_len=3D`sed -ne 's/^.*time_delta.*:[^0-9]*\([0-9][0-9]*\).*/\=
1/p' events/header_event`
            time_len=3D`sed -n '/time_delta/s![^0-9]*!!gp' events/header_ev=
ent`

> +       array_len=3D`sed -ne 's/^.*array.*:[^0-9]*\([0-9][0-9]*\).*/\1/p'=
 events/header_event`
            array_len=3D`sed -n '/array/s![^0-9]*!!gp' events/header_event`

> +       total_bits=3D$((type_len+time_len+array_len))
> +       total_bits=3D$((total_bits+7))
> +       echo $((total_bits/8))
> +}
> +
> +get_print_event_buf_offset() {
> +       sed -ne 's/^.*buf.*offset:\([0-9][0-9]*\).*/\1/p' events/ftrace/p=
rint/format
            sed -n 's!.*buf.*offset:\([^;]*\).*!\1!p' events/ftrace/print/f=
ormat
> +}
> +
> +event_header_size=3D`get_event_header_size`
> +print_header_size=3D`get_print_event_buf_offset`
> +
> +data_offset=3D`get_buffer_data_offset`
> +
> +marker_meta=3D$((event_header_size+print_header_size))
> +
> +make_str() {
> +        cnt=3D$1
> +       # subtract two for \n\0 as marker adds these
> +       cnt=3D$((cnt-2))
> +       printf -- 'X%.0s' $(seq $cnt)
> +}
> +
> +write_buffer() {
> +       size=3D$1
> +
> +       str=3D`make_str $size`
> +
> +       # clear the buffer
> +       echo > trace
> +
> +       # write the string into the marker
> +       echo -n $str > trace_marker
> +
> +       echo $str
> +}
> +
> +test_buffer() {
> +
> +       size=3D`get_buffer_data_size`
> +       oneline_size=3D$((size-marker_meta))
> +       echo size =3D $size
> +       echo meta size =3D $marker_meta
> +
> +       # Now add a little more the meta data overhead will overflow
> +
> +       str=3D`write_buffer $size`
> +
> +       # Make sure the line was broken
> +       new_str=3D`awk ' /tracing_mark_write:/ { sub(/^.*tracing_mark_wri=
te: /,"");printf "%s", $0; exit}' trace`
> +
> +       if [ "$new_str" =3D "$str" ]; then
> +               exit fail;
> +       fi
> +
> +       # Make sure the entire line can be found
> +       new_str=3D`awk ' /tracing_mark_write:/ { sub(/^.*tracing_mark_wri=
te: */,"");printf "%s", $0; }' trace`
> +
> +       if [ "$new_str" !=3D "$str" ]; then
> +               exit fail;
> +       fi
> +}
> +
> +test_buffer
> --
> 2.42.0
>