Skip to content

x86/insn: Add an insn_decode() API

Borislav Petkov lkml 3 versions – Applied

Status from this message: The following commit has been merged into the x86/core branch of tip:

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest21 patches 10 repliesApplied
  2. v221 patches 3 repliesSuperseded
  3. v119 patches 21 repliesSuperseded

Changelog from the cover letter

==========

Patches in v3 Applied

#Subject and filesSizeRepliesApplied
1/21x86/insn: Rename insn_decode() to insn_decode_from_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/21x86/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/21x86/insn: Add a __ignore_sync_check__ markerarch/x86/include/asm/inat.h arch/x86/include/asm/insn.h arch/x86/lib/inat.c +7 more+36 -201 reply
4/21x86/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+452 -1076 replies
5/21x86/insn-eval: Handle return values from the decoderarch/x86/lib/insn-eval.c+21 -130 replies
6/21x86/boot/compressed/sev-es: Convert to insn_decode()arch/x86/boot/compressed/sev-es.c+5 -60 replies
7/21perf/x86/intel/ds: Check insn_get_length() retvalarch/x86/events/intel/ds.c+5 -60 replies
8/21perf/x86/intel/ds: Check return values of insn decoder functionsarch/x86/events/intel/lbr.c+5 -50 replies
9/21x86/alternative: Use insn_decode()arch/x86/kernel/alternative.c+3 -30 replies
10/21x86/mce: Convert to insn_decode()arch/x86/kernel/cpu/mce/severity.c+4 -80 replies
11/21x86/kprobes: Convert to insn_decode()arch/x86/kernel/kprobes/core.c arch/x86/kernel/kprobes/opt.c+18 -80 replies
12/21x86/sev-es: Split vc_decode_insn()arch/x86/kernel/sev-es.c+38 -210 replies
13/21x86/sev-es: Convert to insn_decode()arch/x86/kernel/sev-es.c+10 -120 replies
14/21x86/traps: Convert to insn_decode()arch/x86/kernel/traps.c+4 -30 replies
15/21x86/uprobes: Convert to insn_decode()arch/x86/kernel/uprobes.c+4 -40 replies
16/21x86/tools/insn_decoder_test: Convert to insn_decode()arch/x86/tools/insn_decoder_test.c+6 -40 replies
17/21tools/objtool: Convert to insn_decode()tools/objtool/arch/x86/decode.c+4 -53 replies
18/21x86/tools/insn_sanity: Convert to insn_decode()arch/x86/tools/insn_sanity.c+4 -40 replies
19/21tools/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
20/21x86/insn: Remove kernel_insn_init()arch/x86/include/asm/insn.h tools/arch/x86/include/asm/insn.h+0 -220 replies
21/21x86/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

4 of 21 patches have a Reviewed-by or Acked-by.

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

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

Read the v3 thread

Cover letter [PATCH v3 00/21] x86/insn: Add an insn_decode() API

From: Borislav Petkov <[email protected]>

Hi all,

here's v3 with the snafu Masami caught, fixed.

The rest is unchanged, it all is based on x86/seves which contains a small fixlet to sev-es.c. If there are no more issues, I'll queue it next week.

Thx.

Changelog:
==========

v2:
--

finally had some time during the merge window to finish reworking this. Most if not all review feedback should be incorporated.

v1:
---

here's v1 with the requested change to return -ENODATA on short input to the decoder. The rest is as in the previous submission.

Only lightly tested.

Thx.

v0:
---

https://lkml.kernel.org/r/[email protected]

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.

Borislav Petkov (21):
x86/insn: Rename insn_decode() to insn_decode_from_regs() x86/insn: Add @buf_len param to insn_init() kernel-doc comment x86/insn: Add a __ignore_sync_check__ marker 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: Split vc_decode_insn()
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                    |  11 +-
 arch/x86/events/intel/lbr.c                   |  10 +-
 arch/x86/include/asm/inat.h                   |   2 +-
 arch/x86/include/asm/insn-eval.h              |   4 +-
 arch/x86/include/asm/insn.h                   |  44 ++--
 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                      |  63 +++--
 arch/x86/kernel/traps.c                       |   7 +-
 arch/x86/kernel/umip.c                        |   2 +-
 arch/x86/kernel/uprobes.c                     |   8 +-
 arch/x86/lib/inat.c                           |   2 +-
 arch/x86/lib/insn-eval.c                      |  40 +--
 arch/x86/lib/insn.c                           | 230 ++++++++++++++----
 arch/x86/tools/insn_decoder_test.c            |  10 +-
 arch/x86/tools/insn_sanity.c                  |   8 +-
 tools/arch/x86/include/asm/inat.h             |   2 +-
 tools/arch/x86/include/asm/insn.h             |  44 ++--
 tools/arch/x86/lib/inat.c                     |   2 +-
 tools/arch/x86/lib/insn.c                     | 230 ++++++++++++++----
 tools/include/linux/kconfig.h                 |  73 ++++++
 tools/objtool/arch/x86/decode.c               |   9 +-
 tools/objtool/sync-check.sh                   |  17 +-
 tools/perf/arch/x86/tests/insn-x86.c          |   9 +-
 tools/perf/arch/x86/util/archinsn.c           |   9 +-
 tools/perf/check-headers.sh                   |  15 +-
 .../intel-pt-decoder/intel-pt-insn-decoder.c  |  17 +-
 30 files changed, 648 insertions(+), 275 deletions(-)
 create mode 100644 tools/include/linux/kconfig.h
Signature · 1 line
2.29.2