Received-SPF: pass (google.com: domain of linux-kernel+bounces-74339-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Valentin Obst <kernel@valentinobst.de>
Date: Wed, 21 Feb 2024 09:53:37 +0100
Subject: [PATCH] x86/tools: fix line number reported for malformed lines
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Message-Id: <20240221-x86-insn-decoder-line-fix-v1-1-47cd5a1718c6@valentinobst.de>
To: Ingo Molnar <mingo@kernel.org>, Ingo Molnar <mingo@redhat.com>
Cc: Andreas Hindborg <a.hindborg@samsung.com>, 
 John Baublitz <john.m.baublitz@gmail.com>, 
 David Rheinsberg <david@readahead.eu>, 
 Greg Kroah-Hartman <gregkh@linuxfoundation.org>, 
 "H. Peter Anvin" <hpa@zytor.com>, Masami Hiramatsu <mhiramat@kernel.org>, 
 Miguel Ojeda <ojeda@kernel.org>, Peter Zijlstra <peterz@infradead.org>, 
 =?utf-8?q?Sergio_Gonz=C3=A1lez_Collado?= <sergio.collado@gmail.com>, 
 Thomas Gleixner <tglx@linutronix.de>, linux-kernel@vger.kernel.org, 
 x86@kernel.org, Valentin Obst <kernel@valentinobst.de>
UI-OutboundReport: notjunk:1;M01:P0:BlQJO2SEwwM=;giTIobp/tT9baZQjNYx+KP3oR6G
 BKjF31uEjg5Uv1fyIwznEnBu+8XXRq3NDOvZS3btIqZvof2KY/FX68Dtzqt5t2ymgdUmJA2G1
 jV2nkbdHbeXSrTYnTBbMP1Qx1JCGyg7Fyh+6+L7epc8quLv+nwsayV3R+ij0JY54K6awOthMb
 kbzMHUkvuU4jtAy/Mw/o1JufpYcTNA4GY6ywLounjl11FwgYgAEwvYRdiZiw0+UdmCBJVRFKP
 IXpfULIavtVKTU7gMOCLlc2K2ujb1oFBw117auc7/1ln8G7XsWS/VWmjBOews1CtLKa8CxxtV
 IqkRf5hd5X/9NyKTc625iObWD2sc6J6Zt2Qe+6pOmEqah0gBqschqEugXd2siCCWmZ+zMzgBu
 viD5nX2vtqZkck6x4XGf4BjoLGIFZjrQEjknVcmTIwdVaQQrDsurQs9nlTWHxDloNFpXI2obg
 uzxJrB+EEzJeWWvXMbxY0Wzo6yMnLv8B4tz0alU407RJRgXsTkJS2cCgrRx7xnGZtBqJdDrpc
 SjkdtBcjGGQU6Isy3qxoSgD+rYbpORl5TGYODEYrGoUJlJQhd8uJovgJxRqfqNI0EmSseapg9
 QCyKUcQoaPcMKokSccIyNDSoTvBeoTpHq7HQj6BFAlRo+Txo4ZUkfB8K2qiAcohTEpLWcS+vk
 3Nd45+BXeDb922Uph/r9jwAzjwxvVEqSNgVs4+YfV9Ew4lcNqcv6/0DcJpDer6SYifJLPBtN3
 G2sPwW7+rc3yYmvqv2aeca7nXyyanr3D2Fl9E27ihoIURWCuts3JrI=

While debugging the `X86_DECODER_SELFTEST` failure first reported in [1],
we noticed that the line numbers reported by the `insn_decoder_test` tool
do not correspond to the line in the output of `objdump_reformat.awk` that
was causing the failure:

  # TEST    posttest
    llvm-objdump -d -j .text ./vmlinux | \
    awk -f ./arch/x86/tools/objdump_reformat.awk | \
    arch/x86/tools/insn_decoder_test -y -v
  arch/x86/tools/insn_decoder_test: error: malformed line 1657116:
  68db0

  $ llvm-objdump -d -j .text ./vmlinux | \
  awk -f ./arch/x86/tools/objdump_reformat.awk > objdump_reformat.txt
  $ head -n `echo 1657116+2 | bc` objdump_reformat.txt | tail -n 5
  ffffffff815430b1        41 8b 47 1c             movl
  ffffffff815430b5        89 c1                   movl
  ffffffff815430b7        81 c9 00 40 00 00       orl
  ffffffff815430bd        41 89 4e 18             movl
  ffffffff815430c1        a8 40                   testb

These lines are perfectly fine. The reason is that the line count reported
by the tool only includes instruction lines, i.e., it does not count symbo=
l
lines.

Add a new variable to count the combined (insn+symbol) line count and
report this in the error message. With this patch, the line reported by th=
e
tool is the line causing the failure (long line wrapped at 75 chars):

  # TEST    posttest
    llvm-objdump -d -j .text ./vmlinux | \
    awk -f ./arch/x86/tools/objdump_reformat.awk | \
    arch/x86/tools/insn_decoder_test -y -v
  arch/x86/tools/insn_decoder_test: error: malformed line 1699686:
  68db0

  $ head -n ` echo 1699686+2 | bc` objdump_reformat.txt | tail -n 5
  ffffffff81568dac        c3                      retq
  <_RNvXsP_NtCs7qddEHlz8fK_4core3fmtRINtNtNtNtB7_4iter8adapters5chain5Chai=
n
  INtNtBA_7flatten7FlattenINtNtB7_6option8IntoIterNtNtB7_4char11EscapeDebu=
g
  EEINtB1a_7FlatMapNtNtNtB7_3str4iter5CharsB1T_NtB2D_23CharEscapeDebugCont=
i
  nueEENtB5_5Debug3fmtB7_>:ffffffff81568db0
  ffffffff81568dad        0f 1f 00                nopl
  ffffffff81568db0        f3 0f 1e fa             endbr64
  ffffffff81568db4        41 56                   pushq

[In this case the line causing the failure is interpreted as two lines by
the tool (due to its length, but this is fixed by [1, 2]), and the second
line is reported. Still the spatial closeness between the reported line an=
d
the line causing the failure would have made debugging a lot easier.]

[1]: https://lore.kernel.org/lkml/Y9ES4UKl%2F+DtvAVS@gmail.com/T/
[2]: https://lore.kernel.org/rust-for-linux/20231119180145.157455-1-sergio=
collado@gmail.com/

Signed-off-by: Valentin Obst <kernel@valentinobst.de>
=2D--
 arch/x86/tools/insn_decoder_test.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/arch/x86/tools/insn_decoder_test.c b/arch/x86/tools/insn_deco=
der_test.c
index 472540aeabc2..727017a3c3c7 100644
=2D-- a/arch/x86/tools/insn_decoder_test.c
+++ b/arch/x86/tools/insn_decoder_test.c
@@ -114,6 +114,7 @@ int main(int argc, char **argv)
 	unsigned char insn_buff[16];
 	struct insn insn;
 	int insns =3D 0;
+	int lines =3D 0;
 	int warnings =3D 0;

 	parse_args(argc, argv);
@@ -123,6 +124,8 @@ int main(int argc, char **argv)
 		int nb =3D 0, ret;
 		unsigned int b;

+		lines++;
+
 		if (line[0] =3D=3D '<') {
 			/* Symbol line */
 			strcpy(sym, line);
@@ -134,12 +137,12 @@ int main(int argc, char **argv)
 		strcpy(copy, line);
 		tab1 =3D strchr(copy, '\t');
 		if (!tab1)
-			malformed_line(line, insns);
+			malformed_line(line, lines);
 		s =3D tab1 + 1;
 		s +=3D strspn(s, " ");
 		tab2 =3D strchr(s, '\t');
 		if (!tab2)
-			malformed_line(line, insns);
+			malformed_line(line, lines);
 		*tab2 =3D '\0';	/* Characters beyond tab2 aren't examined */
 		while (s < tab2) {
 			if (sscanf(s, "%x", &b) =3D=3D 1) {

=2D--
base-commit: b401b621758e46812da61fa58a67c3fd8d91de0d
change-id: 20240221-x86-insn-decoder-line-fix-7b1f2e1732ff

Best regards,
=2D-
Valentin Obst <kernel@valentinobst.de>