QEMU-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: John Snow <jsnow@redhat.com>
To: "Philippe Mathieu-Daudé" <philmd@redhat.com>, qemu-devel@nongnu.org
Cc: Fam Zheng <fam@euphon.net>, Paolo Bonzini <pbonzini@redhat.com>,
	Jason Wang <jasowang@redhat.com>,
	Stefan Hajnoczi <stefanha@redhat.com>,
	qemu-block@nongnu.org
Subject: Re: [Qemu-devel] [Qemu-block] [PATCH 2/2] trace: Forbid event format ending with newline character
Date: Fri, 13 Sep 2019 16:01:32 -0400
Message-ID: <965bb469-c5a0-d854-ba32-ac5485ffae1d@redhat.com> (raw)
In-Reply-To: <20190913105205.7581-3-philmd@redhat.com>



On 9/13/19 6:52 AM, Philippe Mathieu-Daudé wrote:
> Event format ending with newlines confuse the trace reports.
> Forbid them.
> 
> Add a check to refuse new format added with trailing newline:
> 
>   $ make
>   [...]
>     GEN     hw/misc/trace.h
>   Traceback (most recent call last):
>     File "scripts/tracetool.py", line 152, in <module>
>       main(sys.argv)
>     File "scripts/tracetool.py", line 143, in main
>       events.extend(tracetool.read_events(fh, arg))
>     File "scripts/tracetool/__init__.py", line 367, in read_events
>       event = Event.build(line)
>     File "scripts/tracetool/__init__.py", line 281, in build
>       raise ValueError("Event format can not end with a newline character")
>   ValueError: Error at hw/misc/trace-events:121: Event format can not end with a newline character
> 
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>  docs/devel/tracing.txt        | 2 ++
>  scripts/tracetool/__init__.py | 3 +++
>  2 files changed, 5 insertions(+)
> 
> diff --git a/docs/devel/tracing.txt b/docs/devel/tracing.txt
> index 76e492a489..8231bbf5d1 100644
> --- a/docs/devel/tracing.txt
> +++ b/docs/devel/tracing.txt
> @@ -112,6 +112,8 @@ Trace events should use types as follows:
>  Format strings should reflect the types defined in the trace event.  Take
>  special care to use PRId64 and PRIu64 for int64_t and uint64_t types,
>  respectively.  This ensures portability between 32- and 64-bit platforms.
> +Format strings must not end with a newline character.  It is the responsibility
> +of backends to adapt line ending for proper logging.
>  
>  Each event declaration will start with the event name, then its arguments,
>  finally a format string for pretty-printing. For example:
> diff --git a/scripts/tracetool/__init__.py b/scripts/tracetool/__init__.py
> index 6fca674936..57df74e67c 100644
> --- a/scripts/tracetool/__init__.py
> +++ b/scripts/tracetool/__init__.py
> @@ -277,6 +277,9 @@ class Event(object):
>          if fmt.find("%m") != -1 or fmt_trans.find("%m") != -1:
>              raise ValueError("Event format '%m' is forbidden, pass the error "
>                               "as an explicit trace argument")
> +        if fmt.endswith("\\n\""):
> +            raise ValueError("Event format must not end with a newline "

It's barely worth mentioning, but you can use r"\n" for cases like this,
if it makes it easier to read.


  reply index

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-13 10:52 [Qemu-devel] [PATCH 0/2] trace: Forbid trailing newline in event format Philippe Mathieu-Daudé
2019-09-13 10:52 ` [Qemu-devel] [PATCH 1/2] trace: Remove trailing newline in events Philippe Mathieu-Daudé
2019-09-13 10:52 ` [Qemu-devel] [PATCH 2/2] trace: Forbid event format ending with newline character Philippe Mathieu-Daudé
2019-09-13 20:01   ` John Snow [this message]
2019-09-13 21:00     ` [Qemu-devel] [Qemu-block] " Philippe Mathieu-Daudé
2019-09-13 21:08       ` John Snow
2019-09-13 20:10 ` [Qemu-devel] [Qemu-block] [PATCH 0/2] trace: Forbid trailing newline in event format John Snow
2019-09-16  8:07 ` Kevin Wolf

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=965bb469-c5a0-d854-ba32-ac5485ffae1d@redhat.com \
    --to=jsnow@redhat.com \
    --cc=fam@euphon.net \
    --cc=jasowang@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=philmd@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

QEMU-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/qemu-devel/0 qemu-devel/git/0.git
	git clone --mirror https://lore.kernel.org/qemu-devel/1 qemu-devel/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 qemu-devel qemu-devel/ https://lore.kernel.org/qemu-devel \
		qemu-devel@nongnu.org qemu-devel@archiver.kernel.org
	public-inbox-index qemu-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.nongnu.qemu-devel


AGPL code for this site: git clone https://public-inbox.org/ public-inbox