Skip to content

RFC x86/insn: Add an insn_decode() API

Borislav Petkov lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v0 RFC Latest19 patches 14 repliesIn review

Patches in v0 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/19x86/insn: Rename insn_decode() to insn_decode_regs()arch/x86/include/asm/insn-eval.h arch/x86/kernel/sev-es.c arch/x86/kernel/umip.c +1 more+7 -70 replies
2/19x86/insn: Add @buf_len param to insn_init() kernel-doc commentarch/x86/lib/insn.c tools/arch/x86/lib/insn.c+2 -00 replies
3/19x86/insn: Add an insn_decode() APIarch/x86/include/asm/insn.h arch/x86/lib/insn.c tools/arch/x86/include/asm/insn.h +2 more+391 -945 replies
4/19x86/insn-eval: Handle return values from the decoderarch/x86/lib/insn-eval.c+9 -50 replies
5/19x86/boot/compressed/sev-es: Convert to insn_decode()arch/x86/boot/compressed/sev-es.c+5 -60 replies
6/19perf/x86/intel/ds: Check insn_get_length() retvalarch/x86/events/intel/ds.c+2 -20 replies
7/19perf/x86/intel/ds: Check return values of insn decoder functionsarch/x86/events/intel/lbr.c+5 -50 replies
8/19x86/alternative: Use insn_decode()arch/x86/kernel/alternative.c+3 -30 replies
9/19x86/mce: Convert to insn_decode()arch/x86/kernel/cpu/mce/severity.c+4 -80 replies
10/19x86/kprobes: Convert to insn_decode()arch/x86/kernel/kprobes/core.c arch/x86/kernel/kprobes/opt.c+18 -81 reply
11/19x86/sev-es: Convert to insn_decode()arch/x86/kernel/sev-es.c+6 -70 replies
12/19x86/traps: Convert to insn_decode()arch/x86/kernel/traps.c+4 -30 replies
13/19x86/uprobes: Convert to insn_decode()arch/x86/kernel/uprobes.c+4 -40 replies
14/19x86/tools/insn_decoder_test: Convert to insn_decode()arch/x86/tools/insn_decoder_test.c+6 -40 replies
15/19tools/objtool: Convert to insn_decode()tools/objtool/arch/x86/decode.c+4 -50 replies
16/19x86/tools/insn_sanity: Convert to insn_decode()arch/x86/tools/insn_sanity.c+4 -40 replies
17/19tools/perf: Convert to insn_decode()tools/perf/arch/x86/tests/insn-x86.c tools/perf/arch/x86/util/archinsn.c tools/perf/util/intel-pt-decoder/intel-pt-insn-decoder.c+19 -160 replies
18/19x86/insn: Remove kernel_insn_init()arch/x86/include/asm/insn.h tools/arch/x86/include/asm/insn.h+0 -220 replies
19/19x86/insn: Make insn_complete() staticarch/x86/include/asm/insn.h arch/x86/lib/insn.c tools/arch/x86/include/asm/insn.h +1 more+14 -140 replies

Reviews trailers per patch

1 of 19 patches has a Reviewed-by or Acked-by.

PatchMasami Hiramatsu
1/19
2/19
3/19
4/19
5/19
6/19
7/19
8/19
9/19
10/19A-b
11/19
12/19
13/19
14/19
15/19
16/19
17/19
18/19
19/19

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v0 thread

Cover letter [RFC PATCH v0 00/19] x86/insn: Add an insn_decode() API

From: Borislav Petkov <[email protected]>

Hi,

here's what I had in mind, finally split into proper patches. The final goal is for all users of the decoder to simply call insn_decode() and look at its retval. Simple.

As to amluto's question about detecting partial insns, see the diff below.

Running that gives:

insn buffer:
0x48 0xcf 0x48 0x83 0x90 0x90 0x90 0x90 0x90 0x90 0x90 0x90 0x90 0x90 0x90 supplied buf size: 15, ret 0
supplied buf size: 2, ret 0
supplied buf size: 3, ret 0
supplied buf size: 4, ret 0

and the return value is always success.

Which means that that buf_len that gets supplied to the decoder functions doesn't really work and I need to look into it.

That is, provided this is how we want to control what the instruction decoder decodes - by supplying the length of the buffer it should look at.

We could also say that probably there should be a way to say "decode only the first insn in the buffer and ignore the rest". That is all up to the use cases so I'm looking for suggestions here.

In any case, at least the case where I give it

0x48 0xcf 0x48 0x83

and say that buf size is 4, should return an error because the second insn is incomplete. So I need to go look at that now.

Thx.

---

arch/x86/tools/insn_sanity.c +41 -0
index 51309df285b4..41e1ae0cd833 100644
@@ -220,6 +220,45 @@ static void parse_args(int argc, char **argv)
 	}
 }
 
+static void run_insn_limits_test(void)
+{
+	unsigned char b[MAX_INSN_SIZE];
+	struct insn insn;
+	int ret, i, size;
+
+	memset(b, INSN_NOP, MAX_INSN_SIZE);
+
+	/* IRETQ */
+	b[0] = 0x48;
+	b[1] = 0xcf;
+
+	/* partial add $0x8, %rsp */
+	b[2] = 0x48;
+	b[3] = 0x83;
+
+	printf("insn buffer:\n");
+
+	for (i = 0; i < MAX_INSN_SIZE; i++)
+		printf("0x%hhx ", b[i]);
+	printf("\n");
+
+	size = MAX_INSN_SIZE;
+	ret = insn_decode(&insn, b, size, INSN_MODE_64);
+	printf("supplied buf size: %d, ret %d\n", size, ret);
+
+	size = 2;
+	ret = insn_decode(&insn, b, size, INSN_MODE_64);
+	printf("supplied buf size: %d, ret %d\n", size, ret);
+
+	size = 3;
+	ret = insn_decode(&insn, b, size, INSN_MODE_64);
+	printf("supplied buf size: %d, ret %d\n", size, ret);
+
+	size = 4;
+	ret = insn_decode(&insn, b, size, INSN_MODE_64);
+	printf("supplied buf size: %d, ret %d\n", size, ret);
+}
+
 int main(int argc, char **argv)
 {
 	int insns = 0, ret;
@@ -265,5 +304,7 @@ int main(int argc, char **argv)
 		errors,
 		seed);
 
+	run_insn_limits_test();
+
 	return errors ? 1 : 0;
 }

Borislav Petkov (19):
x86/insn: Rename insn_decode() to insn_decode_regs() x86/insn: Add @buf_len param to insn_init() kernel-doc comment x86/insn: Add an insn_decode() API
x86/insn-eval: Handle return values from the decoder x86/boot/compressed/sev-es: Convert to insn_decode() perf/x86/intel/ds: Check insn_get_length() retval perf/x86/intel/ds: Check return values of insn decoder functions x86/alternative: Use insn_decode()
x86/mce: Convert to insn_decode()
x86/kprobes: Convert to insn_decode()
x86/sev-es: Convert to insn_decode()
x86/traps: Convert to insn_decode()
x86/uprobes: Convert to insn_decode() x86/tools/insn_decoder_test: Convert to insn_decode() tools/objtool: Convert to insn_decode() x86/tools/insn_sanity: Convert to insn_decode() tools/perf: Convert to insn_decode()
x86/insn: Remove kernel_insn_init()
x86/insn: Make insn_complete() static

 arch/x86/boot/compressed/sev-es.c             |  11 +-
 arch/x86/events/intel/ds.c                    |   4 +-
 arch/x86/events/intel/lbr.c                   |  10 +-
 arch/x86/include/asm/insn-eval.h              |   4 +-
 arch/x86/include/asm/insn.h                   |  42 ++--
 arch/x86/kernel/alternative.c                 |   6 +-
 arch/x86/kernel/cpu/mce/severity.c            |  12 +-
 arch/x86/kernel/kprobes/core.c                |  17 +-
 arch/x86/kernel/kprobes/opt.c                 |   9 +-
 arch/x86/kernel/sev-es.c                      |  15 +-
 arch/x86/kernel/traps.c                       |   7 +-
 arch/x86/kernel/umip.c                        |   2 +-
 arch/x86/kernel/uprobes.c                     |   8 +-
 arch/x86/lib/insn-eval.c                      |  20 +-
 arch/x86/lib/insn.c                           | 190 ++++++++++++++----
 arch/x86/tools/insn_decoder_test.c            |  10 +-
 arch/x86/tools/insn_sanity.c                  |   8 +-
 tools/arch/x86/include/asm/insn.h             |  42 ++--
 tools/arch/x86/lib/insn.c                     | 190 ++++++++++++++----
 tools/include/linux/kconfig.h                 |  73 +++++++
 tools/objtool/arch/x86/decode.c               |   9 +-
 tools/perf/arch/x86/tests/insn-x86.c          |   9 +-
 tools/perf/arch/x86/util/archinsn.c           |   9 +-
 .../intel-pt-decoder/intel-pt-insn-decoder.c  |  17 +-
 24 files changed, 507 insertions(+), 217 deletions(-)
 create mode 100644 tools/include/linux/kconfig.h
Signature · 1 line
2.21.0