Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) client-ip=2620:137:e000::3:4;
MIME-Version: 1.0
References: <20231130234048.157509-1-lb@semihalf.com> <20231130234048.157509-6-lb@semihalf.com>
 <20231130192554.10da680c@gandalf.local.home>
In-Reply-To: <20231130192554.10da680c@gandalf.local.home>
From:   =?UTF-8?Q?=C5=81ukasz_Bartosik?= <lb@semihalf.com>
Date:   Fri, 1 Dec 2023 10:00:51 +0100
Message-ID: <CAK8ByeK8dGcbxfXghw6=LrhSWLmO0a4XuB8C0nsUc812aoU0Pw@mail.gmail.com>
Subject: Re: [PATCH v2 05/15] tracefs: add __get_str_strip_nl - RFC
To:     Steven Rostedt <rostedt@goodmis.org>
Cc:     Jason Baron <jbaron@akamai.com>, Jim Cromie <jim.cromie@gmail.com>,
        Andrew Morton <akpm@linux-foundation.org>,
        Kees Cook <keescook@chromium.org>,
        Douglas Anderson <dianders@chromium.org>,
        Guenter Roeck <groeck@google.com>,
        Yaniv Tzoreff <yanivt@google.com>,
        Benson Leung <bleung@google.com>,
        Vincent Whitchurch <vincent.whitchurch@axis.com>,
        Pekka Paalanen <ppaalanen@gmail.com>,
        Sean Paul <seanpaul@chromium.org>,
        Daniel Vetter <daniel@ffwll.ch>, linux-kernel@vger.kernel.org,
        upstream@semihalf.com, pmladek@suse.com,
        sergey.senozhatsky@gmail.com, john.ogness@linutronix.de,
        Simon Ser <contact@emersion.fr>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

pt., 1 gru 2023 o 01:25 Steven Rostedt <rostedt@goodmis.org> napisa=C5=82(a=
):
>
> On Fri,  1 Dec 2023 00:40:38 +0100
> =C5=81ukasz Bartosik <lb@semihalf.com> wrote:
>
> > From: Jim Cromie <jim.cromie@gmail.com>
> >
> > This variant of __get_str() removes the trailing newline. It is for
> > use by printk/debug-ish events which already have a trailing newline.
> > It is here to support:
> >
> > https://lore.kernel.org/lkml/
> > 20200825153338.17061-1-vincent.whitchurch@axis.com/
>
> Line wrap breakage.
>

I will fix it.

> > which taught dyndbg to send pr_debug() msgs to tracefs, via -x/T flag.
> >
> > It "reused" the include/trace/events/printk.h console event,
> > which does the following:
> >
> >        TP_fast_assign(
> >                /*
> >                 * Each trace entry is printed in a new line.
> >                 * If the msg finishes with '\n', cut it off
> >                 * to avoid blank lines in the trace.
> >                 */
> >                if (len > 0 && (msg[len-1] =3D=3D '\n'))
> >                        len -=3D 1;
> >
> >                memcpy(__get_str(s), msg, len);
> >                __get_str(s)[len] =3D 0;
> >       ),
> >
> > That trim work could be avoided, *if* all pr_debug() callers are
> > known to have no '\n' to strip.  While that's not true for *all*
> > callsites, it is 99+% true for DRM.debug callsites, and can be made
> > true for some subsets of prdbg/dyndbg callsites.
> >
> > WANTED: macros to validate that a literal format-str has or doesn't
> > have a trailing newline, or to provide or trim trailing newline(s?).
> > Should be usable in TP_printk* defns, for use in new event defns.
> >
> > Cc: <rostedt@goodmis.org>
> > Cc: Vincent Whitchurch <vincent.whitchurch@axis.com>
> > Cc: <daniel@ffwll.ch>
> > Cc: <pmladek@suse.com>
> > Cc: <sergey.senozhatsky@gmail.com>
> > Cc: <john.ogness@linutronix.de>
> > Cc: Simon Ser <contact@emersion.fr>
> > Cc: Sean Paul <seanpaul@chromium.org>
> > Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
> > Signed-off-by: =C5=81ukasz Bartosik <lb@semihalf.com>
> > ---
> >  include/trace/stages/stage3_trace_output.h | 9 +++++++++
> >  1 file changed, 9 insertions(+)
> >
> > diff --git a/include/trace/stages/stage3_trace_output.h b/include/trace=
/stages/stage3_trace_output.h
> > index c1fb1355d309..92a79bd5c0cd 100644
> > --- a/include/trace/stages/stage3_trace_output.h
> > +++ b/include/trace/stages/stage3_trace_output.h
> > @@ -19,6 +19,15 @@
> >  #undef __get_str
> >  #define __get_str(field) ((char *)__get_dynamic_array(field))
> >
> > +#undef __get_str_strip_nl
> > +#define __get_str_strip_nl(field)                                    \
> > +     ({                                                              \
> > +             char *s =3D __get_str(field);                            =
 \
> > +             size_t len =3D strlen(s);                                =
 \
> > +             if (len && s[len-1] =3D=3D '\n')                         =
   \
> > +                     s[len-1] =3D '\0'; s;                            =
 \
> > +     })
>
> I'd be worried about modifying the string itself as you are doing above.
> That's modifying the source which may have unintended consequences.
>
> That said, there's a trace_seq that is available for stage 3 called "p".
> You can use that:
>
> #define __get_str_strip_nl(field)                                       \
>         ({                                                              \
>                 char *s =3D trace_seq_buffer_ptr(p);                     =
 \
>                 size_t len;                                             \
>                 trace_seq_printf(p, "%s", __get_str(field));            \
>                 trace_seq_putc(p, '\0');                                \
>                 len =3D strlen(s);                                       =
 \
>                 if (len && s[len-1] =3D=3D '\n')                         =
   \
>                         s[len-1] =3D '\0';                               =
 \
>                 s;                                                      \
>         })
>
> -- Steve
>

Thank you Steve. I will update the __get_str_strip_nl macro per your
recommendation.

> > +
> >  #undef __get_rel_dynamic_array
> >  #define __get_rel_dynamic_array(field)                                =
       \
> >               ((void *)__entry +                                      \
>