From nobody Wed Nov 12 05:44:51 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1568627665; cv=none; d=zoho.com; s=zohoarc; b=lxg49Axbo1XW66xNHclZV3vThR0W/BWc+8E8LKLMxsywXgh0qPriqXWeF+CXg8PfMXTKDxxdet+bK/x60+7nfge8x/tL5ATIBdt9B2PH+hBiUQOBYj0aavGPKlpIXcaAQb4taQ9XhJyDVWcTS7gQljevAUgEkU60aU2nnOwsjv4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1568627665; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=YBiDCqS14KBwyA7PbB2Kv2qII0C1zEic/N0S49P5F8s=; b=YCjVZ6Kmd7IeNqKVQwmE5mHpNceGjU98bFIownIO4sh+SPjNYISt7Z5q6SLZJuFJwLVxlHd0CWWCX/pPsfaDNK/IkoGsYMB/cbGZZF5zkwQNjUHK/0sXaavCp5hNH0yK9YdDdnArkTVmGWRrM/6wYhL2kAJX/GgNJBz/53dpCqE= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1568627665667617.5079968839001; Mon, 16 Sep 2019 02:54:25 -0700 (PDT) Received: from localhost ([::1]:60666 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1i9niC-00012x-EW for importer@patchew.org; Mon, 16 Sep 2019 05:54:24 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43148) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1i9nfe-0006Ss-Th for qemu-devel@nongnu.org; Mon, 16 Sep 2019 05:51:49 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1i9nfd-0008Jm-Kg for qemu-devel@nongnu.org; Mon, 16 Sep 2019 05:51:46 -0400 Received: from mx1.redhat.com ([209.132.183.28]:62506) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1i9nfa-0008Ig-S4; Mon, 16 Sep 2019 05:51:42 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 11D2283F3B; Mon, 16 Sep 2019 09:51:42 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-115.brq.redhat.com [10.40.204.115]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 843A75C1D6; Mon, 16 Sep 2019 09:51:38 +0000 (UTC) From: =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Mon, 16 Sep 2019 11:51:21 +0200 Message-Id: <20190916095121.29506-3-philmd@redhat.com> In-Reply-To: <20190916095121.29506-1-philmd@redhat.com> References: <20190916095121.29506-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.27]); Mon, 16 Sep 2019 09:51:42 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v2 2/2] trace: Forbid event format ending with newline character X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , Kevin Wolf , qemu-block@nongnu.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Jason Wang , John Snow , Stefan Hajnoczi , Paolo Bonzini Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" 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 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 =3D 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 w= ith a newline character Reviewed-by: John Snow Reviewed-by: Kevin Wolf Signed-off-by: Philippe Mathieu-Daud=C3=A9 --- v2: "\\n\"" -> r'\n"' (jsnow) --- 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 responsib= ility +of backends to adapt line ending for proper logging. =20 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..04279fa62e 100644 --- a/scripts/tracetool/__init__.py +++ b/scripts/tracetool/__init__.py @@ -277,6 +277,9 @@ class Event(object): if fmt.find("%m") !=3D -1 or fmt_trans.find("%m") !=3D -1: raise ValueError("Event format '%m' is forbidden, pass the err= or " "as an explicit trace argument") + if fmt.endswith(r'\n"'): + raise ValueError("Event format must not end with a newline " + "character") =20 if len(fmt_trans) > 0: fmt =3D [fmt_trans, fmt] --=20 2.20.1