x86/insn: Add an insn_decode() API
Subsystems (5)
Borislav Petkov
maintainercover x86/insn: Add an insn_decode() API
From: Borislav Petkov <[email protected]>
Hi,
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.
changelog:
==========
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.
Thx.
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 | 25 +- arch/x86/lib/insn.c | 247 ++++++++++++++---- 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 | 247 ++++++++++++++---- 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, 595 insertions(+), 248 deletions(-) create mode 100644 tools/include/linux/kconfig.h
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 2/19 x86/insn: Add @buf_len param to insn_init() kernel-doc comment
From: Borislav Petkov <[email protected]>
It wasn't documented so add it. No functional changes.
--- arch/x86/lib/insn.c | 1 + tools/arch/x86/lib/insn.c | 1 + 2 files changed, 2 insertions(+)
arch/x86/lib/insn.c +1 -0
@@ -37,6 +37,7 @@* insn_init() - initialize struct insn * @insn: &struct insn to be initialized * @kaddr: address (in kernel memory) of instruction (or copy thereof) +* @buf_len: length of the insn buffer at @kaddr * @x86_64: !0 for 64-bit kernel or 64-bit app */ void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64)
tools/arch/x86/lib/insn.c +1 -0
@@ -37,6 +37,7 @@* insn_init() - initialize struct insn * @insn: &struct insn to be initialized * @kaddr: address (in kernel memory) of instruction (or copy thereof) +* @buf_len: length of the insn buffer at @kaddr * @x86_64: !0 for 64-bit kernel or 64-bit app */ void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64)
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 4/19 x86/insn-eval: Handle return values from the decoder
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Now that the different instruction-inspecting functions return a value, test that and return early from callers if error has been encountered.
While at it, do not call insn_get_modrm() when calling insn_get_displacement() because latter will make sure to call insn_get_modrm() if ModRM hasn't been parsed yet.
--- arch/x86/lib/insn-eval.c | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-)
arch/x86/lib/insn-eval.c +13 -6
@@ -1106,18 +1106,21 @@ static int get_eff_addr_modrm_16(struct insn *insn, struct pt_regs *regs,* @base_offset will have a register, as an offset from the base of pt_regs, * that can be used to resolve the associated segment. * -* -EINVAL on error. +* Negative value on error. */ static int get_eff_addr_sib (struct insn *insn,struct pt_regs *regs,int *base_offset,long *eff_addr) {long base, indx;int indx_offset; +int ret;if (insn->addr_bytes !=8 && insn->addr_bytes !=4 )return -EINVAL ; -insn_get_modrm (insn); + ret =insn_get_modrm (insn); +if (ret) +return ret;if (!insn->modrm.nbytes)return -EINVAL ;
@@ -1125,7 +1128,9 @@ static int get_eff_addr_sib(struct insn *insn, struct pt_regs *regs,if (X86_MODRM_MOD (insn->modrm.value) >2 )return -EINVAL ; -insn_get_sib (insn); + ret =insn_get_sib (insn); +if (ret) +return ret;if (!insn->sib.nbytes)return -EINVAL ;
@@ -1194,8 +1199,8 @@ static void __user *get_addr_ref_16(struct insn *insn, struct pt_regs *regs)short eff_addr;long tmp; -insn_get_modrm (insn); -insn_get_displacement (insn); +if (insn_get_displacement (insn)) + goto out;if (insn->addr_bytes !=2 ) goto out;
@@ -1491,7 +1496,9 @@ bool insn_decode_regs(struct insn *insn, struct pt_regs *regs, insn->addr_bytes =INSN_CODE_SEG_ADDR_SZ (seg_defs); insn->opnd_bytes =INSN_CODE_SEG_OPND_SZ (seg_defs); -insn_get_length (insn); +if (insn_get_length (insn)) +return false; +if (buf_size < insn->length)return false;
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 7/19 perf/x86/intel/ds: Check return values of insn decoder functions
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
branch_type() doesn't need to call the full insn_decode() because it doesn't need it in all cases thus leave the calls separate.
--- arch/x86/events/intel/lbr.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
arch/x86/events/intel/lbr.c +5 -5
@@ -1224,8 +1224,7 @@ static int branch_type(unsigned long from, unsigned long to, int abort) is64 =kernel_ip ((unsigned long )addr) ||any_64bit_mode (current_pt_regs ());#endif insn_init (&insn, addr, bytes_read, is64); -insn_get_opcode (&insn); -if (!insn.opcode.got) +if (insn_get_opcode (&insn))return X86_BR_ABORT ;switch (insn.opcode.bytes[0 ]) {
@@ -1262,8 +1261,7 @@ static int branch_type(unsigned long from, unsigned long to, int abort) ret =X86_BR_INT ;break ;case 0xe8 :/* call near rel */ -insn_get_immediate (&insn); -if (insn.immediate1.value ==0 ) { +if (insn_get_immediate (&insn) || insn.immediate1.value ==0 ) {/* zero length call */ ret =X86_BR_ZERO_CALL ;break ;
@@ -1279,7 +1277,9 @@ static int branch_type(unsigned long from, unsigned long to, int abort) ret =X86_BR_JMP ;break ;case 0xff :/* call near absolute, call far absolute ind */ -insn_get_modrm (&insn); +if (insn_get_modrm (&insn)) +return X86_BR_ABORT ; + ext = (insn.modrm.bytes[0 ] >>3 ) &0x7 ;switch (ext) {case 2 :/* near ind call */
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 1/19 x86/insn: Rename insn_decode() to insn_decode_regs()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Rename insn_decode() to insn_decode_regs() to denote that it receives regs as param and free the name for a more generic version of the function.
No functional changes.
--- arch/x86/include/asm/insn-eval.h | 4 ++-- arch/x86/kernel/sev-es.c | 2 +- arch/x86/kernel/umip.c | 2 +- arch/x86/lib/insn-eval.c | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-)
arch/x86/include/asm/insn-eval.h +2 -2
@@ -23,7 +23,7 @@ unsigned long insn_get_seg_base(struct pt_regs *regs, int seg_reg_idx);int insn_get_code_seg_params (struct pt_regs *regs);int insn_fetch_from_user (struct pt_regs *regs,unsigned char buf[MAX_INSN_SIZE ]); -bool insn_decode (struct insn *insn,struct pt_regs *regs, -unsigned char buf[MAX_INSN_SIZE ],int buf_size); +bool insn_decode_regs (struct insn *insn,struct pt_regs *regs, +unsigned char buf[MAX_INSN_SIZE ],int buf_size);#endif /* _ASM_X86_INSN_EVAL_H */
arch/x86/kernel/sev-es.c +1 -1
@@ -256,7 +256,7 @@ static enum es_result vc_decode_insn(struct es_em_ctxt *ctxt)return ES_EXCEPTION ; } -if (!insn_decode (&ctxt->insn, ctxt->regs, buffer, res)) +if (!insn_decode_regs (&ctxt->insn, ctxt->regs, buffer, res))return ES_DECODE_FAILED ; }else { res =vc_fetch_insn_kernel (ctxt, buffer);
arch/x86/kernel/umip.c +1 -1
@@ -356,7 +356,7 @@ bool fixup_umip_exception(struct pt_regs *regs)if (!nr_copied)return false; -if (!insn_decode (&insn, regs, buf, nr_copied)) +if (!insn_decode_regs (&insn, regs, buf, nr_copied))return false; umip_inst =identify_insn (&insn);
arch/x86/lib/insn-eval.c +3 -3
@@ -1454,7 +1454,7 @@ int insn_fetch_from_user(struct pt_regs *regs, unsigned char buf[MAX_INSN_SIZE]) }/** -* insn_decode() - Decode an instruction +* insn_decode_regs() - Decode an instruction * @insn: Structure to store decoded instruction * @regs: Structure with register values as seen when entering kernel mode * @buf: Buffer containing the instruction bytes
@@ -1467,8 +1467,8 @@ int insn_fetch_from_user(struct pt_regs *regs, unsigned char buf[MAX_INSN_SIZE])* * True if instruction was decoded, False otherwise. */ -bool insn_decode (struct insn *insn,struct pt_regs *regs, -unsigned char buf[MAX_INSN_SIZE ],int buf_size) +bool insn_decode_regs (struct insn *insn,struct pt_regs *regs, +unsigned char buf[MAX_INSN_SIZE ],int buf_size) {int seg_defs;
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 9/19 x86/mce: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- arch/x86/kernel/cpu/mce/severity.c | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-)
arch/x86/kernel/cpu/mce/severity.c +4 -8
@@ -218,15 +218,15 @@ static struct severity {static bool is_copy_from_user (struct pt_regs *regs) {u8 insn_buf[MAX_INSN_SIZE ]; -struct insn insn;unsigned long addr; +struct insn insn; +int ret;if (copy_from_kernel_nofault (insn_buf, (void *)regs->ip,MAX_INSN_SIZE ))return false; -kernel_insn_init (&insn, insn_buf,MAX_INSN_SIZE ); -insn_get_opcode (&insn); -if (!insn.opcode.got) + ret =insn_decode (&insn, insn_buf,MAX_INSN_SIZE ,INSN_MODE_KERN ); +if (ret <0 )return false;switch (insn.opcode.value) {
@@ -234,10 +234,6 @@ static bool is_copy_from_user(struct pt_regs *regs)case 0x8A :case 0x8B :/* MOVZ mem,reg */ case 0xB60F :case 0xB70F : -insn_get_modrm (&insn); -insn_get_sib (&insn); -if (!insn.modrm.got || !insn.sib.got) -return false; addr = (unsigned long )insn_get_addr_ref (&insn, regs);break ;/* REP MOVS */
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 12/19 x86/traps: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- arch/x86/kernel/traps.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
arch/x86/kernel/traps.c +4 -3
@@ -497,14 +497,15 @@ static enum kernel_gp_hint get_kernel_gp_address(struct pt_regs *regs, {u8 insn_buf[MAX_INSN_SIZE ];struct insn insn; +int ret;if (copy_from_kernel_nofault (insn_buf, (void *)regs->ip,MAX_INSN_SIZE ))return GP_NO_HINT ; -kernel_insn_init (&insn, insn_buf,MAX_INSN_SIZE ); -insn_get_modrm (&insn); -insn_get_sib (&insn); + ret =insn_decode (&insn, insn_buf,MAX_INSN_SIZE ,INSN_MODE_KERN ); +if (ret <0 ) +return GP_NO_HINT ; *addr = (unsigned long )insn_get_addr_ref (&insn, regs);if (*addr ==-1UL )
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 15/19 tools/objtool: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- tools/objtool/arch/x86/decode.c | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
tools/objtool/arch/x86/decode.c +4 -5
@@ -90,7 +90,7 @@ int arch_decode_instruction(const struct elf *elf, const struct section *sec, struct list_head *ops_list) {struct insn insn; -int x86_64, sign; +int x86_64, sign, ret;unsigned char op1, op2, rex =0 , rex_b =0 , rex_r =0 , rex_w =0 , rex_x =0 , modrm =0 , modrm_mod =0 , modrm_rm =0 , modrm_reg =0 , sib =0 ;
@@ -101,10 +101,9 @@ int arch_decode_instruction(const struct elf *elf, const struct section *sec,if (x86_64 ==-1 )return -1 ; -insn_init (&insn, sec->data->d_buf + offset, maxlen, x86_64); -insn_get_length (&insn); - -if (!insn_complete (&insn)) { + ret =insn_decode (&insn, sec->data->d_buf + offset, maxlen, + x86_64 ?INSN_MODE_64 :INSN_MODE_32 ); +if (ret <0 ) {WARN ("can't decode instruction at %s:0x%lx" , sec->name, offset);return -1 ; }
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 17/19 tools/perf: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- 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 ++++++++++------- 3 files changed, 19 insertions(+), 16 deletions(-)
tools/perf/arch/x86/tests/insn-x86.c +4 -5
@@ -95,13 +95,12 @@ static int get_branch(const char *branch_str)static int test_data_item (struct test_data *dat,int x86_64) {struct intel_pt_insn intel_pt_insn; +int op, branch, ret;struct insn insn; -int op, branch; -insn_init (&insn, dat->data,MAX_INSN_SIZE , x86_64); -insn_get_length (&insn); - -if (!insn_complete (&insn)) { + ret =insn_decode (&insn, dat->data,MAX_INSN_SIZE , + x86_64 ?INSN_MODE_64 :INSN_MODE_32 ); +if (ret <0 ) {pr_debug ("Failed to decode: %s\n" , dat->asm_rep);return -1 ; }
tools/perf/arch/x86/util/archinsn.c +5 -4
@@ -11,7 +11,7 @@ void arch_fetch_insn(struct perf_sample *sample, struct machine *machine) {struct insn insn; -int len; +int len, ret;bool is64bit = false;if (!sample->ip)
@@ -19,8 +19,9 @@ void arch_fetch_insn(struct perf_sample *sample, len =thread__memcpy (thread, machine, sample->insn, sample->ip,sizeof (sample->insn), &is64bit);if (len <=0 )return ; -insn_init (&insn, sample->insn, len, is64bit); -insn_get_length (&insn); -if (insn_complete (&insn) && insn.length <= len) + + ret =insn_decode (&insn, sample->insn, len, + is64bit ?INSN_MODE_64 :INSN_MODE_32 ); +if (ret >=0 && insn.length <= len) sample->insn_len = insn.length; }
tools/perf/util/intel-pt-decoder/intel-pt-insn-decoder.c +10 -7
@@ -158,11 +158,13 @@ int intel_pt_get_insn(const unsigned char *buf, size_t len, int x86_64, struct intel_pt_insn *intel_pt_insn) {struct insn insn; +int ret; -insn_init (&insn, buf, len, x86_64); -insn_get_length (&insn); -if (!insn_complete (&insn) || insn.length > len) + ret =insn_decode (&insn, buf, len, + x86_64 ?INSN_MODE_64 :INSN_MODE_32 ); +if (ret <0 || insn.length > len)return -1 ; +intel_pt_insn_decoder (&insn, intel_pt_insn);if (insn.length <INTEL_PT_INSN_BUF_SZ )memcpy (intel_pt_insn->buf, buf, insn.length);
@@ -183,12 +185,13 @@ const char *dump_insn(struct perf_insn *x, uint64_t ip __maybe_unused, u8 *inbuf, int inlen, int *lenp) { struct insn insn; -int n, i; +int n, i, ret;int left; -insn_init (&insn, inbuf, inlen, x->is64bit); -insn_get_length (&insn); -if (!insn_complete (&insn) || insn.length > inlen) + ret =insn_decode (&insn, inbuf, inlen, + x->is64bit ?INSN_MODE_64 :INSN_MODE_32 ); + +if (ret <0 || insn.length > inlen)return "<bad>" ;if (lenp) *lenp = insn.length;
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 19/19 x86/insn: Make insn_complete() static
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
... and move it above the only place it is used.
--- arch/x86/include/asm/insn.h | 7 ------- arch/x86/lib/insn.c | 7 +++++++ tools/arch/x86/include/asm/insn.h | 7 ------- tools/arch/x86/lib/insn.c | 7 +++++++ 4 files changed, 14 insertions(+), 14 deletions(-)
arch/x86/include/asm/insn.h +0 -7
@@ -133,13 +133,6 @@ static inline int insn_has_emulate_prefix(struct insn *insn)return !!insn->emulate_prefix_size; } -/* Ensure this instruction is decoded completely */ -static inline int insn_complete (struct insn *insn) -{ -return insn->opcode.got && insn->modrm.got && insn->sib.got && - insn->displacement.got && insn->immediate.got; -} -static inline insn_byte_t insn_vex_m_bits (struct insn *insn) {if (insn->vex_prefix.nbytes ==2 )/* 2 bytes VEX */
arch/x86/lib/insn.c +7 -0
@@ -726,6 +726,13 @@ int insn_get_length(struct insn *insn)return 0 ; } +/* Ensure this instruction is decoded completely */ +static inline int insn_complete (struct insn *insn) +{ +return insn->opcode.got && insn->modrm.got && insn->sib.got && + insn->displacement.got && insn->immediate.got; +} +/** * insn_decode() - Decode an x86 instruction * @insn: &struct insn to be initialized
tools/arch/x86/include/asm/insn.h +0 -7
@@ -133,13 +133,6 @@ static inline int insn_has_emulate_prefix(struct insn *insn)return !!insn->emulate_prefix_size; } -/* Ensure this instruction is decoded completely */ -static inline int insn_complete (struct insn *insn) -{ -return insn->opcode.got && insn->modrm.got && insn->sib.got && - insn->displacement.got && insn->immediate.got; -} -static inline insn_byte_t insn_vex_m_bits (struct insn *insn) {if (insn->vex_prefix.nbytes ==2 )/* 2 bytes VEX */
tools/arch/x86/lib/insn.c +7 -0
@@ -726,6 +726,13 @@ int insn_get_length(struct insn *insn)return 0 ; } +/* Ensure this instruction is decoded completely */ +static inline int insn_complete (struct insn *insn) +{ +return insn->opcode.got && insn->modrm.got && insn->sib.got && + insn->displacement.got && insn->immediate.got; +} +/** * insn_decode() - Decode an x86 instruction * @insn: &struct insn to be initialized
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 6/19 perf/x86/intel/ds: Check insn_get_length() retval
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
intel_pmu_pebs_fixup_ip() needs only the insn length so use the appropriate helper instead of a full decode. A full decode differs only in running insn_complete() on the decoded insn but that is not needed here.
--- arch/x86/events/intel/ds.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
arch/x86/events/intel/ds.c +2 -2
@@ -1265,14 +1265,14 @@ static int intel_pmu_pebs_fixup_ip(struct pt_regs *regs) is_64bit =kernel_ip (to) ||any_64bit_mode (regs);#endif insn_init (&insn, kaddr, size, is_64bit); -insn_get_length (&insn); +/* * Make sure there was not a problem decoding the * instruction and getting the length. This is * doubly important because we have an infinite * loop if insn.length=0. */ -if (!insn.length) +if (insn_get_length (&insn) || !insn.length)break ; to += insn.length;
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 8/19 x86/alternative: Use insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
No functional changes, just simplification.
--- arch/x86/kernel/alternative.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
arch/x86/kernel/alternative.c +3 -3
@@ -1274,15 +1274,15 @@ static void text_poke_loc_init(struct text_poke_loc *tp, void *addr, const void *opcode, size_t len, const void *emulate) { struct insn insn; +int ret;memcpy ((void *)tp->text, opcode, len);if (!emulate) emulate = opcode; -kernel_insn_init (&insn, emulate,MAX_INSN_SIZE ); -insn_get_length (&insn); + ret =insn_decode (&insn, emulate,MAX_INSN_SIZE ,INSN_MODE_KERN ); -BUG_ON (!insn_complete (&insn)); +BUG_ON (ret <0 );BUG_ON (len != insn.length); tp->rel_addr = addr - (void *)_stext;
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 10/19 x86/kprobes: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, improve decoding error checking.
--- arch/x86/kernel/kprobes/core.c | 17 +++++++++++------ arch/x86/kernel/kprobes/opt.c | 9 +++++++-- 2 files changed, 18 insertions(+), 8 deletions(-)
arch/x86/kernel/kprobes/core.c +11 -6
@@ -285,6 +285,8 @@ static int can_probe(unsigned long paddr)/* Decode instructions */ addr = paddr - offset;while (addr < paddr) { +int ret; +/* * Check if the instruction has been modified by another * kprobe, in which case we replace the breakpoint by the
@@ -296,8 +298,10 @@ static int can_probe(unsigned long paddr) __addr =recover_probed_instruction (buf, addr);if (!__addr)return 0 ; -kernel_insn_init (&insn, (void *)__addr,MAX_INSN_SIZE ); -insn_get_length (&insn); + + ret =insn_decode (&insn, (void *)__addr,MAX_INSN_SIZE ,INSN_MODE_KERN ); +if (ret <0 ) +return 0 ;/* * Another debugging subsystem might insert this breakpoint.
@@ -340,8 +344,8 @@ static int is_IF_modifier(kprobe_opcode_t *insn)int __copy_instruction (u8 *dest,u8 *src,u8 *real,struct insn *insn) {kprobe_opcode_t buf[MAX_INSN_SIZE ]; -unsigned long recovered_insn = -recover_probed_instruction (buf, (unsigned long )src); +unsigned long recovered_insn =recover_probed_instruction (buf, (unsigned long )src); +int ret;if (!recovered_insn || !insn)return 0 ;
@@ -351,8 +355,9 @@ int __copy_instruction(u8 *dest, u8 *src, u8 *real, struct insn *insn) MAX_INSN_SIZE))return 0 ; -kernel_insn_init (insn, dest,MAX_INSN_SIZE ); -insn_get_length (insn); + ret =insn_decode (insn, dest,MAX_INSN_SIZE ,INSN_MODE_KERN ); +if (ret <0 ) +return 0 ;/* We can not probe force emulate prefixed instruction */ if (insn_has_emulate_prefix (insn))
arch/x86/kernel/kprobes/opt.c +7 -2
@@ -312,6 +312,8 @@ static int can_optimize(unsigned long paddr) addr = paddr - offset;while (addr < paddr - offset + size) {/* Decode until function end */ unsigned long recovered_insn; +int ret; +if (search_exception_tables (addr))/* * Since some fixup code will jumps into this function,
@@ -321,8 +323,11 @@ static int can_optimize(unsigned long paddr) recovered_insn =recover_probed_instruction (buf, addr);if (!recovered_insn)return 0 ; -kernel_insn_init (&insn, (void *)recovered_insn,MAX_INSN_SIZE ); -insn_get_length (&insn); + + ret =insn_decode (&insn, (void *)recovered_insn,MAX_INSN_SIZE ,INSN_MODE_KERN ); +if (ret <0 ) +return 0 ; +/* * In the case of detecting unknown breakpoint, this could be * a padding INT3 between functions. Let's check that all the
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 11/19 x86/sev-es: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- arch/x86/kernel/sev-es.c | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-)
arch/x86/kernel/sev-es.c +6 -7
@@ -244,8 +244,7 @@ static int vc_fetch_insn_kernel(struct es_em_ctxt *ctxt,static enum es_result vc_decode_insn (struct es_em_ctxt *ctxt) {char buffer[MAX_INSN_SIZE ]; -enum es_result ret; -int res; +int res, ret;if (user_mode (ctxt->regs)) { res =insn_fetch_from_user (ctxt->regs, buffer);
@@ -267,13 +266,13 @@ static enum es_result vc_decode_insn(struct es_em_ctxt *ctxt)return ES_EXCEPTION ; } -insn_init (&ctxt->insn, buffer,MAX_INSN_SIZE - res,1 ); -insn_get_length (&ctxt->insn); + ret =insn_decode (&ctxt->insn, buffer,MAX_INSN_SIZE - res,INSN_MODE_64 ); } - ret = ctxt->insn.immediate.got ?ES_OK :ES_DECODE_FAILED ; - -return ret; +if (ret <0 ) +return ES_DECODE_FAILED ; +else +return ES_OK ; } static enum es_result vc_write_mem(struct es_em_ctxt *ctxt,
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 5/19 x86/boot/compressed/sev-es: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Other than simplifying the code there should be no functional changes resulting from this.
--- arch/x86/boot/compressed/sev-es.c | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-)
arch/x86/boot/compressed/sev-es.c +5 -6
@@ -78,16 +78,15 @@ static inline void sev_es_wr_ghcb_msr(u64 val)static enum es_result vc_decode_insn (struct es_em_ctxt *ctxt) {char buffer[MAX_INSN_SIZE ]; -enum es_result ret; +int ret;memcpy (buffer, (unsigned char *)ctxt->regs->ip,MAX_INSN_SIZE ); -insn_init (&ctxt->insn, buffer,MAX_INSN_SIZE ,1 ); -insn_get_length (&ctxt->insn); + ret =insn_decode (&ctxt->insn, buffer,MAX_INSN_SIZE ,INSN_MODE_64 ); +if (ret <0 ) +return ES_DECODE_FAILED ; - ret = ctxt->insn.immediate.got ?ES_OK :ES_DECODE_FAILED ; - -return ret; +return ES_OK ; } static enum es_result vc_write_mem(struct es_em_ctxt *ctxt,
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 13/19 x86/uprobes: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- arch/x86/kernel/uprobes.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
arch/x86/kernel/uprobes.c +4 -4
@@ -276,12 +276,12 @@ static bool is_prefix_bad(struct insn *insn)static int uprobe_init_insn (struct arch_uprobe *auprobe,struct insn *insn,bool x86_64) { +enum insn_mode m = x86_64 ?INSN_MODE_64 :INSN_MODE_32 ;u32 volatile *good_insns; +int ret; -insn_init (insn, auprobe->insn,sizeof (auprobe->insn), x86_64); -/* has the side-effect of processing the entire instruction */ -insn_get_length (insn); -if (!insn_complete (insn)) + ret =insn_decode (insn, auprobe->insn,sizeof (auprobe->insn), m); +if (ret <0 )return -ENOEXEC ;if (is_prefix_bad (insn))
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 14/19 x86/tools/insn_decoder_test: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- arch/x86/tools/insn_decoder_test.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
arch/x86/tools/insn_decoder_test.c +6 -4
@@ -120,7 +120,7 @@ int main(int argc, char **argv)while (fgets (line,BUFSIZE , stdin)) {char copy[BUFSIZE ], *s, *tab1, *tab2; -int nb =0 ; +int nb =0 , ret;unsigned int b;if (line[0 ] =='<' ) {
@@ -148,10 +148,12 @@ int main(int argc, char **argv) }else break ; } +/* Decode an instruction */ -insn_init (&insn, insn_buff,sizeof (insn_buff), x86_64); -insn_get_length (&insn); -if (insn.length != nb) { + ret =insn_decode (&insn, insn_buff,sizeof (insn_buff), + x86_64 ?INSN_MODE_64 :INSN_MODE_32 ); + +if (ret <0 || insn.length != nb) { warnings++;pr_warn ("Found an x86 instruction decoder bug, " "please report this.\n" , sym);
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 16/19 x86/tools/insn_sanity: Convert to insn_decode()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Simplify code, no functional changes.
--- arch/x86/tools/insn_sanity.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
arch/x86/tools/insn_sanity.c +4 -4
@@ -222,8 +222,8 @@ static void parse_args(int argc, char **argv)int main (int argc,char **argv) { +int insns =0 , ret;struct insn insn; -int insns =0 ;int errors =0 ;unsigned long i;unsigned char insn_buff[MAX_INSN_SIZE *2 ];
@@ -241,15 +241,15 @@ int main(int argc, char **argv)continue ;/* Decode an instruction */ -insn_init (&insn, insn_buff,sizeof (insn_buff), x86_64); -insn_get_length (&insn); + ret =insn_decode (&insn, insn_buff,sizeof (insn_buff), + x86_64 ?INSN_MODE_64 :INSN_MODE_32 );if (insn.next_byte <= insn.kaddr || insn.kaddr +MAX_INSN_SIZE < insn.next_byte) {/* Access out-of-range memory */ dump_stream (stderr,"Error: Found an access violation" , i, insn_buff, &insn); errors++; - }else if (verbose && !insn_complete (&insn)) + }else if (verbose && ret <0 )dump_stream (stdout,"Info: Found an undecodable input" , i, insn_buff, &insn);else if (verbose >=2 )dump_insn (stdout, &insn);
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 18/19 x86/insn: Remove kernel_insn_init()
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Now that it is not needed anymore, drop it.
--- arch/x86/include/asm/insn.h | 11 ----------- tools/arch/x86/include/asm/insn.h | 11 ----------- 2 files changed, 22 deletions(-)
arch/x86/include/asm/insn.h +0 -11
@@ -114,17 +114,6 @@ static inline void insn_get_attribute(struct insn *insn)/* Instruction uses RIP-relative addressing */ extern int insn_rip_relative (struct insn *insn); -/* Init insn for kernel text */ -static inline void kernel_insn_init (struct insn *insn, -const void *kaddr,int buf_len) -{ -#ifdef CONFIG_X86_64 -insn_init (insn, kaddr, buf_len,1 ); -#else /* CONFIG_X86_32 */ -insn_init (insn, kaddr, buf_len,0 ); -#endif -} -static inline int insn_is_avx (struct insn *insn) {if (!insn->prefixes.got)
tools/arch/x86/include/asm/insn.h +0 -11
@@ -114,17 +114,6 @@ static inline void insn_get_attribute(struct insn *insn)/* Instruction uses RIP-relative addressing */ extern int insn_rip_relative (struct insn *insn); -/* Init insn for kernel text */ -static inline void kernel_insn_init (struct insn *insn, -const void *kaddr,int buf_len) -{ -#ifdef CONFIG_X86_64 -insn_init (insn, kaddr, buf_len,1 ); -#else /* CONFIG_X86_32 */ -insn_init (insn, kaddr, buf_len,0 ); -#endif -} -static inline int insn_is_avx (struct insn *insn) {if (!insn->prefixes.got)
Signature · 1 line
2.29.2
Borislav Petkov
maintainerPATCH 3/19 x86/insn: Add an insn_decode() API
In reply to Borislav PetkovFrom: Borislav Petkov <[email protected]>
Users of the instruction decoder should use this to decode instruction bytes. For that, have insn*() helpers return an int value to denote success/failure. When there's an error fetching the next insn byte and the insn falls short, return -ENODATA to denote that.
While at it, make insn_get_opcode() more stricter as to whether what has seen so far is a valid insn and if not.
Copy linux/kconfig.h for the tools-version of the decoder so that it can use IS_ENABLED().
--- arch/x86/include/asm/insn.h | 24 ++- arch/x86/lib/insn.c | 239 +++++++++++++++++++++++------- tools/arch/x86/include/asm/insn.h | 24 ++- tools/arch/x86/lib/insn.c | 239 +++++++++++++++++++++++------- tools/include/linux/kconfig.h | 73 +++++++++ 5 files changed, 475 insertions(+), 124 deletions(-) create mode 100644 tools/include/linux/kconfig.h
arch/x86/include/asm/insn.h +17 -7
@@ -87,13 +87,23 @@ struct insn {#define X86_VEX_M_MAX 0x1f/* VEX3.M Maximum value */ extern void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64); -extern void insn_get_prefixes (struct insn *insn); -extern void insn_get_opcode (struct insn *insn); -extern void insn_get_modrm (struct insn *insn); -extern void insn_get_sib (struct insn *insn); -extern void insn_get_displacement (struct insn *insn); -extern void insn_get_immediate (struct insn *insn); -extern void insn_get_length (struct insn *insn); +extern int insn_get_prefixes (struct insn *insn); +extern int insn_get_opcode (struct insn *insn); +extern int insn_get_modrm (struct insn *insn); +extern int insn_get_sib (struct insn *insn); +extern int insn_get_displacement (struct insn *insn); +extern int insn_get_immediate (struct insn *insn); +extern int insn_get_length (struct insn *insn); + +enum insn_mode { +INSN_MODE_32 , +INSN_MODE_64 , +/* Mode is determined by the current kernel build. */ +INSN_MODE_KERN , +INSN_NUM_MODES , +}; + +extern int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m);/* Attribute will be determined after getting ModRM (for opcode groups) */ static inline void insn_get_attribute (struct insn *insn)
arch/x86/lib/insn.c +184 -55
434 lines not on this page · raw message
tools/arch/x86/include/asm/insn.h +17 -7
@@ -87,13 +87,23 @@ struct insn {#define X86_VEX_M_MAX 0x1f/* VEX3.M Maximum value */ extern void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64); -extern void insn_get_prefixes (struct insn *insn); -extern void insn_get_opcode (struct insn *insn); -extern void insn_get_modrm (struct insn *insn); -extern void insn_get_sib (struct insn *insn); -extern void insn_get_displacement (struct insn *insn); -extern void insn_get_immediate (struct insn *insn); -extern void insn_get_length (struct insn *insn); +extern int insn_get_prefixes (struct insn *insn); +extern int insn_get_opcode (struct insn *insn); +extern int insn_get_modrm (struct insn *insn); +extern int insn_get_sib (struct insn *insn); +extern int insn_get_displacement (struct insn *insn); +extern int insn_get_immediate (struct insn *insn); +extern int insn_get_length (struct insn *insn); + +enum insn_mode { +INSN_MODE_32 , +INSN_MODE_64 , +/* Mode is determined by the current kernel build. */ +INSN_MODE_KERN , +INSN_NUM_MODES , +}; + +extern int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m);/* Attribute will be determined after getting ModRM (for opcode groups) */ static inline void insn_get_attribute (struct insn *insn)
tools/arch/x86/lib/insn.c +184 -55
434 lines not on this page · raw message
tools/include/linux/kconfig.h new file +73 -0
73 lines not on this page · raw message
Signature · 1 line
2.29.2
kernel test robot
build botRe: [PATCH v1 11/19] x86/sev-es: Convert to insn_decode()
In reply to Borislav PetkovI love your patch! Perhaps something to improve:
Hi Borislav,
I love your patch! Perhaps something to improve:
[auto build test WARNING on linus/master]
[also build test WARNING on v5.10 next-20201223]
[cannot apply to tip/perf/core tip/x86/core luto/next]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/Borislav-Petkov/x86-insn-Add-an-insn_decode-API/20201224-014846 base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 614cb5894306cfa2c7d9b6168182876ff5948735 config: x86_64-randconfig-a016-20201223 (attached as .config) compiler: clang version 12.0.0 (https://github.com/llvm/llvm-project cee1e7d14f4628d6174b33640d502bff3b54ae45)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# install x86_64 cross compiling tool for clang build
# apt-get install binutils-x86-64-linux-gnu
# https://github.com/0day-ci/linux/commit/9cc93591504c88c42ab10903fc69062fc1461ed0
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review Borislav-Petkov/x86-insn-Add-an-insn_decode-API/20201224-014846 git checkout 9cc93591504c88c42ab10903fc69062fc1461ed0
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
>> arch/x86/kernel/sev-es.c:258:7: warning: variable 'ret' is used uninitialized whenever 'if' condition is false [-Wsometimes-uninitialized]
if (!insn_decode_regs(&ctxt->insn, ctxt->regs, buffer, res))
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
arch/x86/kernel/sev-es.c:272:6: note: uninitialized use occurs here
if (ret < 0)
^~~
arch/x86/kernel/sev-es.c:258:3: note: remove the 'if' if its condition is always true
if (!insn_decode_regs(&ctxt->insn, ctxt->regs, buffer, res))
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
arch/x86/kernel/sev-es.c:247:14: note: initialize the variable 'ret' to silence this warning
int res, ret;
^
= 01 warning generated.
vim +258 arch/x86/kernel/sev-es.c
f980f9c31a923e9 Joerg Roedel 2020-09-07 243
f980f9c31a923e9 Joerg Roedel 2020-09-07 244 static enum es_result vc_decode_insn(struct es_em_ctxt *ctxt)
f980f9c31a923e9 Joerg Roedel 2020-09-07 245 {
f980f9c31a923e9 Joerg Roedel 2020-09-07 246 char buffer[MAX_INSN_SIZE];
9cc93591504c88c Borislav Petkov 2020-12-23 247 int res, ret;
f980f9c31a923e9 Joerg Roedel 2020-09-07 248
5e3427a7bc432ed Joerg Roedel 2020-09-07 249 if (user_mode(ctxt->regs)) {
5e3427a7bc432ed Joerg Roedel 2020-09-07 250 res = insn_fetch_from_user(ctxt->regs, buffer);
5e3427a7bc432ed Joerg Roedel 2020-09-07 251 if (!res) {
5e3427a7bc432ed Joerg Roedel 2020-09-07 252 ctxt->fi.vector = X86_TRAP_PF;
5e3427a7bc432ed Joerg Roedel 2020-09-07 253 ctxt->fi.error_code = X86_PF_INSTR | X86_PF_USER;
5e3427a7bc432ed Joerg Roedel 2020-09-07 254 ctxt->fi.cr2 = ctxt->regs->ip;
5e3427a7bc432ed Joerg Roedel 2020-09-07 255 return ES_EXCEPTION;
5e3427a7bc432ed Joerg Roedel 2020-09-07 256 }
5e3427a7bc432ed Joerg Roedel 2020-09-07 257
63d702bf108e3ad Borislav Petkov 2020-12-23 @258 if (!insn_decode_regs(&ctxt->insn, ctxt->regs, buffer, res))
5e3427a7bc432ed Joerg Roedel 2020-09-07 259 return ES_DECODE_FAILED;
5e3427a7bc432ed Joerg Roedel 2020-09-07 260 } else {
f980f9c31a923e9 Joerg Roedel 2020-09-07 261 res = vc_fetch_insn_kernel(ctxt, buffer);
5e3427a7bc432ed Joerg Roedel 2020-09-07 262 if (res) {
f980f9c31a923e9 Joerg Roedel 2020-09-07 263 ctxt->fi.vector = X86_TRAP_PF;
5e3427a7bc432ed Joerg Roedel 2020-09-07 264 ctxt->fi.error_code = X86_PF_INSTR;
f980f9c31a923e9 Joerg Roedel 2020-09-07 265 ctxt->fi.cr2 = ctxt->regs->ip;
f980f9c31a923e9 Joerg Roedel 2020-09-07 266 return ES_EXCEPTION;
f980f9c31a923e9 Joerg Roedel 2020-09-07 267 }
f980f9c31a923e9 Joerg Roedel 2020-09-07 268
9cc93591504c88c Borislav Petkov 2020-12-23 269 ret = insn_decode(&ctxt->insn, buffer, MAX_INSN_SIZE - res, INSN_MODE_64);
5e3427a7bc432ed Joerg Roedel 2020-09-07 270 }
f980f9c31a923e9 Joerg Roedel 2020-09-07 271
9cc93591504c88c Borislav Petkov 2020-12-23 272 if (ret < 0)
9cc93591504c88c Borislav Petkov 2020-12-23 273 return ES_DECODE_FAILED;
9cc93591504c88c Borislav Petkov 2020-12-23 274 else
9cc93591504c88c Borislav Petkov 2020-12-23 275 return ES_OK;
f980f9c31a923e9 Joerg Roedel 2020-09-07 276 }
f980f9c31a923e9 Joerg Roedel 2020-09-07 277 ---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/[email protected]
Borislav Petkov
maintainerRe: [PATCH v1 11/19] x86/sev-es: Convert to insn_decode()
Quoted 8 lines · kernel test robot
If you fix the issue, kindly add following tag as appropriate
Reported-by kernel test robot <[email protected]>All warnings (new ones prefixed by >>):
Quoted 1 line
Quoted 1 line
arch/x86/kernel/sev-es.c:258:7: warning: variable 'ret' is used uninitialized whenever 'if' condition is false [-Wsometimes-uninitialized]if (!insn_decode_regs(&ctxt->insn, ctxt->regs, buffer, res)) ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yeah, good catch, thanks for reporting.
Frankly, the readability and "extensiblity" of that function can be improved by splitting the two cases (diff ontop):
---
arch/x86/kernel/sev-es.c +36 -23
@@ -241,40 +241,53 @@ static int vc_fetch_insn_kernel(struct es_em_ctxt *ctxt,return copy_from_kernel_nofault (buffer, (unsigned char *)ctxt->regs->ip,MAX_INSN_SIZE ); } -static enum es_result vc_decode_insn (struct es_em_ctxt *ctxt) +static enum es_result __vc_decode_user_insn (struct es_em_ctxt *ctxt) {char buffer[MAX_INSN_SIZE ]; -int res, ret; - -if (user_mode (ctxt->regs)) { - res =insn_fetch_from_user (ctxt->regs, buffer); -if (!res) { - ctxt->fi.vector =X86_TRAP_PF ; - ctxt->fi.error_code =X86_PF_INSTR |X86_PF_USER ; - ctxt->fi.cr2 = ctxt->regs->ip; -return ES_EXCEPTION ; - } +int res; -if (!insn_decode_regs (&ctxt->insn, ctxt->regs, buffer, res)) -return ES_DECODE_FAILED ; - }else { - res =vc_fetch_insn_kernel (ctxt, buffer); -if (res) { - ctxt->fi.vector =X86_TRAP_PF ; - ctxt->fi.error_code =X86_PF_INSTR ; - ctxt->fi.cr2 = ctxt->regs->ip; -return ES_EXCEPTION ; - } + res =insn_fetch_from_user (ctxt->regs, buffer); +if (!res) { + ctxt->fi.vector =X86_TRAP_PF ; + ctxt->fi.error_code =X86_PF_INSTR |X86_PF_USER ; + ctxt->fi.cr2 = ctxt->regs->ip; +return ES_EXCEPTION ; + } + +if (!insn_decode_regs (&ctxt->insn, ctxt->regs, buffer, res)) +return ES_DECODE_FAILED ; +else +return ES_OK ; +} + +static enum es_result __vc_decode_kern_insn (struct es_em_ctxt *ctxt) +{ +char buffer[MAX_INSN_SIZE ]; +int res; - ret =insn_decode (&ctxt->insn, buffer,MAX_INSN_SIZE - res,INSN_MODE_64 ); + res =vc_fetch_insn_kernel (ctxt, buffer); +if (res) { + ctxt->fi.vector =X86_TRAP_PF ; + ctxt->fi.error_code =X86_PF_INSTR ; + ctxt->fi.cr2 = ctxt->regs->ip; +return ES_EXCEPTION ; } -if (ret <0 ) + res =insn_decode (&ctxt->insn, buffer,MAX_INSN_SIZE - res,INSN_MODE_64 ); +if (res <0 )return ES_DECODE_FAILED ;else return ES_OK ; } +static enum es_result vc_decode_insn (struct es_em_ctxt *ctxt) +{ +if (user_mode (ctxt->regs)) +return __vc_decode_user_insn (ctxt); +else +return __vc_decode_kern_insn (ctxt); +} +static enum es_result vc_write_mem (struct es_em_ctxt *ctxt,char *dst,char *buf,size_t size) {
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteQuoted 14 lines · Borislav Petkov
From: Borislav Petkov <[email protected]>
Hi,
here's v1 with the requested change to return
-ENODATAon short input to the decoder. The rest is as in the previous submission.Only lightly tested.
Thx.
changelog:
==========
Quoted 7 lines
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.
That's the way it works today, right? One instruction, no matter the length of the buffer (assuming the length is long enough to include a full instruction)?
Because the callers of the decode may rely on parsing only the current instruction (like SEV-ES), it should probably default to that (although most of the call points are being updated so you could supply a boolean to indicate one vs many instructions). The caller doesn't necessarily know the length of the instruction, so it may provide a buffer of max instruction length.
Also, if you want to parse more than one instruction at a time, wouldn't you need to maintain register context within the parsing, I don't think that is done today. Or you could chain together some instruction contexts to identify each instruction that was parsed?
Thanks,
Tom
Quoted 1 line
Hi,
Quoted 6 lines · On Wed, 23 Dec 2020 18:42:17 +0100 Borislav Petkov <[email protected]> wrote:
From: Borislav Petkov <[email protected]>
Users of the instruction decoder should use this to decode instruction bytes. For that, have insn*() helpers return an int value to denote success/failure. When there's an error fetching the next insn byte and the insn falls short, return
-ENODATAto denote that.
-ENODATA sounds good to me :)
BTW, insn_decode() can return -EINVAL if !insn_complete(), is that OK?
Quoted 6 lines
While at it, make
insn_get_opcode()more stricter as to whether what has seen so far is a valid insn and if not.Copy
linux/kconfig.hfor the tools-version of the decoder so that it can useIS_ENABLED().
I think tools clone code must not use INSN_MODE_KERN because the tools may not use kernel Kconfig.
Hmm, this may be better to make a different patch to introduce a NOSYNC tag for sync checker in the tools. Something like;
arch/x86/lib/insn.c void insn_get_immediate(struct insn *insn) · line 744
Quoted 5 lines
arch/x86/lib/insn.c +5
-0+int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m) +{ +int ret; + +if (m ==INSN_MODE_KERN )
return -EINVAL; /* NOSYNC */
arch/x86/lib/insn.c void insn_get_immediate(struct insn *insn) · line 748
Quoted 3 lines
arch/x86/lib/insn.c +3
-0+else +insn_init (insn, kaddr, buf_len, m ==INSN_MODE_64 ); +
Then we can simple file list for sync-check.sh.
Thank you,
Quoted 1,081 lines
Signed-off-by Borislav Petkov <[email protected]>--- arch/x86/include/asm/insn.h | 24 ++- arch/x86/lib/insn.c | 239 +++++++++++++++++++++++------- tools/arch/x86/include/asm/insn.h | 24 ++- tools/arch/x86/lib/insn.c | 239 +++++++++++++++++++++++------- tools/include/linux/kconfig.h | 73 +++++++++ 5 files changed, 475 insertions(+), 124 deletions(-) create mode 100644 tools/include/linux/kconfig.harch/x86/include/asm/insn.h +17
-7@@ -87,13 +87,23 @@ struct insn {#define X86_VEX_M_MAX 0x1f/* VEX3.M Maximum value */ extern void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64); -extern void insn_get_prefixes (struct insn *insn); -extern void insn_get_opcode (struct insn *insn); -extern void insn_get_modrm (struct insn *insn); -extern void insn_get_sib (struct insn *insn); -extern void insn_get_displacement (struct insn *insn); -extern void insn_get_immediate (struct insn *insn); -extern void insn_get_length (struct insn *insn); +extern int insn_get_prefixes (struct insn *insn); +extern int insn_get_opcode (struct insn *insn); +extern int insn_get_modrm (struct insn *insn); +extern int insn_get_sib (struct insn *insn); +extern int insn_get_displacement (struct insn *insn); +extern int insn_get_immediate (struct insn *insn); +extern int insn_get_length (struct insn *insn); + +enum insn_mode { +INSN_MODE_32 , +INSN_MODE_64 , +/* Mode is determined by the current kernel build. */ +INSN_MODE_KERN , +INSN_NUM_MODES , +}; + +extern int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m);/* Attribute will be determined after getting ModRM (for opcode groups) */ static inline void insn_get_attribute (struct insn *insn)arch/x86/lib/insn.c +184
-55@@ -13,6 +13,9 @@#include <asm/inat.h> #include <asm/insn.h> +#include <linux/errno.h> +#include <linux/kconfig.h> +#include <asm/emulate_prefix.h> /* Verify next sizeof(t) bytes can be on the same instruction */ @@ -80,12 +83,15 @@ static int __insn_get_emulate_prefix(struct insn *insn,return 1 ; err_out: -return 0 ; +return -ENODATA ; }static void insn_get_emulate_prefix (struct insn *insn) { -if (__insn_get_emulate_prefix (insn, xen_prefix,sizeof (xen_prefix))) +int ret; + + ret =__insn_get_emulate_prefix (insn, xen_prefix,sizeof (xen_prefix)); +if (ret >0 )return ;__insn_get_emulate_prefix (insn, kvm_prefix,sizeof (kvm_prefix));@@ -98,8 +104,12 @@ static void insn_get_emulate_prefix(struct insn *insn)* Populates the @insn->prefixes bitmap, and updates @insn->next_byte * to point to the (first) opcode. No effect if @insn->prefixes.got * is already set. +* +* * Returns: +* 0: on success +* < 0: on error */ -void insn_get_prefixes (struct insn *insn) +int insn_get_prefixes (struct insn *insn) {struct insn_field *prefixes = &insn->prefixes;insn_attr_t attr;@@ -107,7 +117,7 @@ void insn_get_prefixes(struct insn *insn)int i, nb;if (prefixes->got) -return ; +return 0 ;insn_get_emulate_prefix (insn);@@ -218,8 +228,10 @@ void insn_get_prefixes(struct insn *insn) prefixes->got =1 ; +return 0 ; + err_out: -return ; +return -ENODATA ; }/** @@ -231,16 +243,25 @@ void insn_get_prefixes(struct insn *insn)* If necessary, first collects any preceding (prefix) bytes. * Sets @insn->opcode.value = opcode1. No effect if @insn->opcode.got * is already 1. +* +* Returns: +* 0: on success +* < 0: on error */ -void insn_get_opcode (struct insn *insn) +int insn_get_opcode (struct insn *insn) {struct insn_field *opcode = &insn->opcode; +int pfx_id, ret;insn_byte_t op; -int pfx_id; +if (opcode->got) -return ; -if (!insn->prefixes.got) -insn_get_prefixes (insn); +return 0 ; + +if (!insn->prefixes.got) { + ret =insn_get_prefixes (insn); +if (ret) +return ret; + }/* Get first opcode */ op =get_next (insn_byte_t, insn);@@ -255,9 +276,13 @@ void insn_get_opcode(struct insn *insn) insn->attr =inat_get_avx_attribute (op, m, p);if ((inat_must_evex (insn->attr) && !insn_is_evex (insn)) || (!inat_accept_vex (insn->attr) && - !inat_is_group (insn->attr))) - insn->attr =0 ;/* This instruction is bad */ - goto end;/* VEX has only 1 byte for opcode */ + !inat_is_group (insn->attr))) { +/* This instruction is bad */ + insn->attr =0 ; +return 1 ; + } +/* VEX has only 1 byte for opcode */ + goto end; } insn->attr =inat_get_opcode_attribute (op);@@ -268,13 +293,18 @@ void insn_get_opcode(struct insn *insn) pfx_id =insn_last_prefix_id (insn); insn->attr =inat_get_escape_attribute (op, pfx_id, insn->attr); } -if (inat_must_vex (insn->attr)) - insn->attr =0 ;/* This instruction is bad */ + +if (inat_must_vex (insn->attr)) { +/* This instruction is bad */ + insn->attr =0 ; +return 1 ; + } end: opcode->got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; }/** @@ -284,15 +314,25 @@ void insn_get_opcode(struct insn *insn)* Populates @insn->modrm and updates @insn->next_byte to point past the * ModRM byte, if any. If necessary, first collects the preceding bytes * (prefixes and opcode(s)). No effect if @insn->modrm.got is already 1. +* +* Returns: +* 0: on success +* < 0: on error */ -void insn_get_modrm (struct insn *insn) +int insn_get_modrm (struct insn *insn) {struct insn_field *modrm = &insn->modrm;insn_byte_t pfx_id, mod; +int ret; +if (modrm->got) -return ; -if (!insn->opcode.got) -insn_get_opcode (insn); +return 0 ; + +if (!insn->opcode.got) { + ret =insn_get_opcode (insn); +if (ret) +return ret; + }if (inat_has_modrm (insn->attr)) { mod =get_next (insn_byte_t, insn);@@ -302,17 +342,22 @@ void insn_get_modrm(struct insn *insn) pfx_id =insn_last_prefix_id (insn); insn->attr =inat_get_group_attribute (mod, pfx_id, insn->attr); -if (insn_is_avx (insn) && !inat_accept_vex (insn->attr)) - insn->attr =0 ;/* This is bad */ +if (insn_is_avx (insn) && !inat_accept_vex (insn->attr)) { +/* Bad insn */ + insn->attr =0 ; +return 1 ; + } } }if (insn->x86_64 &&inat_is_force64 (insn->attr)) insn->opnd_bytes =8 ; + modrm->got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; }@@ -326,11 +371,16 @@ void insn_get_modrm(struct insn *insn)int insn_rip_relative (struct insn *insn) {struct insn_field *modrm = &insn->modrm; +int ret;if (!insn->x86_64)return 0 ; -if (!modrm->got) -insn_get_modrm (insn); + +if (!modrm->got) { + ret =insn_get_modrm (insn); +if (ret) +return ret; + }/* * For rip-relative instructions, the mod field (top 2 bits) * is zero and the r/m field (bottom 3 bits) is 0x5. @@ -344,15 +394,25 @@ int insn_rip_relative(struct insn *insn)* * If necessary, first collects the instruction up to and including the * ModRM byte. +* +* Returns: +* 0: if decoding succeeded +* < 0: otherwise. */ -void insn_get_sib (struct insn *insn) +int insn_get_sib (struct insn *insn) {insn_byte_t modrm; +int ret;if (insn->sib.got) -return ; -if (!insn->modrm.got) -insn_get_modrm (insn); +return 0 ; + +if (!insn->modrm.got) { + ret =insn_get_modrm (insn); +if (ret) +return ret; + } +if (insn->modrm.nbytes) { modrm = (insn_byte_t )insn->modrm.value; if (insn->addr_bytes != 2 &&@@ -363,8 +423,10 @@ void insn_get_sib(struct insn *insn) } insn->sib.got =1 ; +return 0 ; + err_out: -return ; +return -ENODATA ; }@@ -375,15 +437,25 @@ void insn_get_sib(struct insn *insn)* If necessary, first collects the instruction up to and including the * SIB byte. * Displacement value is sign-expanded. +* +* * Returns: +* 0: if decoding succeeded +* < 0: otherwise. */ -void insn_get_displacement (struct insn *insn) +int insn_get_displacement (struct insn *insn) {insn_byte_t mod, rm, base; +int ret;if (insn->displacement.got) -return ; -if (!insn->sib.got) -insn_get_sib (insn); +return 0 ; + +if (!insn->sib.got) { + ret =insn_get_sib (insn); +if (ret) +return ret; + } +if (insn->modrm.nbytes) {/* * Interpreting the modrm byte: @@ -426,12 +498,13 @@ void insn_get_displacement(struct insn *insn) } out: insn->displacement.got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; } -/* Decode moffset16/32/64. Return 0 if failed */ +/* Decode moffset16/32/64. Return a negative value if failed. */ static int __get_moffset (struct insn *insn) {switch (insn->addr_bytes) {@@ -457,10 +530,10 @@ static int __get_moffset(struct insn *insn)return 1 ; err_out: -return 0 ; +return -ENODATA ; } -/* Decode imm v32(Iz). Return 0 if failed */ +/* Decode imm v32(Iz). Return a negative value if failed. */ static int __get_immv32 (struct insn *insn) {switch (insn->opnd_bytes) {@@ -480,10 +553,10 @@ static int __get_immv32(struct insn *insn)return 1 ; err_out: -return 0 ; +return -ENODATA ; } -/* Decode imm v64(Iv/Ov), Return 0 if failed */ +/* Decode imm v64(Iv/Ov). Return a negative value if failed. */ static int __get_immv (struct insn *insn) {switch (insn->opnd_bytes) {@@ -507,11 +580,12 @@ static int __get_immv(struct insn *insn) insn->immediate1.got = insn->immediate2.got =1 ;return 1 ; + err_out: -return 0 ; +return -ENODATA ; } -/* Decode ptr16:16/32(Ap) */ +/* Decode ptr16:16/32(Ap). Return a negative value if failed. */ static int __get_immptr (struct insn *insn) {switch (insn->opnd_bytes) {@@ -534,25 +608,36 @@ static int __get_immptr(struct insn *insn) insn->immediate1.got = insn->immediate2.got =1 ;return 1 ; + err_out: -return 0 ; +return -ENODATA ; }/** -* insn_get_immediate() - Get the immediates of instruction +* insn_get_immediate() - Get the immediate in an instruction * @insn: &struct insn containing instruction * * If necessary, first collects the instruction up to and including the * displacement bytes. * Basically, most of immediates are sign-expanded. Unsigned-value can be -* get by bit masking with ((1 << (nbytes * 8)) - 1) +* computed by bit masking with ((1 << (nbytes * 8)) - 1) +* +* Returns: +* 0: on success +* < 0: on error */ -void insn_get_immediate (struct insn *insn) +int insn_get_immediate (struct insn *insn) { +int ret; +if (insn->immediate.got) -return ; -if (!insn->displacement.got) -insn_get_displacement (insn); +return 0 ; + +if (!insn->displacement.got) { + ret =insn_get_displacement (insn); +if (ret) +return ret; + }if (inat_has_moffset (insn->attr)) {if (!__get_moffset (insn))@@ -605,9 +690,10 @@ void insn_get_immediate(struct insn *insn) } done: insn->immediate.got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; }/** @@ -616,13 +702,56 @@ void insn_get_immediate(struct insn *insn)* * If necessary, first collects the instruction up to and including the * immediates bytes. -*/ -void insn_get_length (struct insn *insn) +* +* Returns: +* - 0 on success +* - < 0 on error +*/ +int insn_get_length (struct insn *insn) { +int ret; +if (insn->length) -return ; -if (!insn->immediate.got) -insn_get_immediate (insn); +return 0 ; + +if (!insn->immediate.got) { + ret =insn_get_immediate (insn); +if (ret) +return ret; + } + insn->length = (unsigned char )((unsigned long )insn->next_byte - (unsigned long )insn->kaddr); + +return 0 ; +} + +/** +* insn_decode() - Decode an x86 instruction +* @insn: &struct insn to be initialized +* @kaddr: address (in kernel memory) of instruction (or copy thereof) +* @buf_len: length of the insn buffer at @kaddr +* @m: insn mode, see enum insn_mode +* +* Returns: +* 0: if decoding succeeded +* < 0: otherwise. +*/ +int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m) +{ +int ret; + +if (m ==INSN_MODE_KERN ) +insn_init (insn, kaddr, buf_len,IS_ENABLED (CONFIG_X86_64 )); +else +insn_init (insn, kaddr, buf_len, m ==INSN_MODE_64 ); + + ret =insn_get_length (insn); +if (ret) +return ret; + +if (insn_complete (insn)) +return 0 ; + +return -EINVAL ; }tools/arch/x86/include/asm/insn.h +17
-7@@ -87,13 +87,23 @@ struct insn {#define X86_VEX_M_MAX 0x1f/* VEX3.M Maximum value */ extern void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64); -extern void insn_get_prefixes (struct insn *insn); -extern void insn_get_opcode (struct insn *insn); -extern void insn_get_modrm (struct insn *insn); -extern void insn_get_sib (struct insn *insn); -extern void insn_get_displacement (struct insn *insn); -extern void insn_get_immediate (struct insn *insn); -extern void insn_get_length (struct insn *insn); +extern int insn_get_prefixes (struct insn *insn); +extern int insn_get_opcode (struct insn *insn); +extern int insn_get_modrm (struct insn *insn); +extern int insn_get_sib (struct insn *insn); +extern int insn_get_displacement (struct insn *insn); +extern int insn_get_immediate (struct insn *insn); +extern int insn_get_length (struct insn *insn); + +enum insn_mode { +INSN_MODE_32 , +INSN_MODE_64 , +/* Mode is determined by the current kernel build. */ +INSN_MODE_KERN , +INSN_NUM_MODES , +}; + +extern int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m);/* Attribute will be determined after getting ModRM (for opcode groups) */ static inline void insn_get_attribute (struct insn *insn)tools/arch/x86/lib/insn.c +184
-55@@ -13,6 +13,9 @@#include "../include/asm/inat.h" #include "../include/asm/insn.h" +#include <linux/errno.h> +#include <linux/kconfig.h> +#include "../include/asm/emulate_prefix.h" /* Verify next sizeof(t) bytes can be on the same instruction */ @@ -80,12 +83,15 @@ static int __insn_get_emulate_prefix(struct insn *insn,return 1 ; err_out: -return 0 ; +return -ENODATA ; }static void insn_get_emulate_prefix (struct insn *insn) { -if (__insn_get_emulate_prefix (insn, xen_prefix,sizeof (xen_prefix))) +int ret; + + ret =__insn_get_emulate_prefix (insn, xen_prefix,sizeof (xen_prefix)); +if (ret >0 )return ;__insn_get_emulate_prefix (insn, kvm_prefix,sizeof (kvm_prefix));@@ -98,8 +104,12 @@ static void insn_get_emulate_prefix(struct insn *insn)* Populates the @insn->prefixes bitmap, and updates @insn->next_byte * to point to the (first) opcode. No effect if @insn->prefixes.got * is already set. +* +* * Returns: +* 0: on success +* < 0: on error */ -void insn_get_prefixes (struct insn *insn) +int insn_get_prefixes (struct insn *insn) {struct insn_field *prefixes = &insn->prefixes;insn_attr_t attr;@@ -107,7 +117,7 @@ void insn_get_prefixes(struct insn *insn)int i, nb;if (prefixes->got) -return ; +return 0 ;insn_get_emulate_prefix (insn);@@ -218,8 +228,10 @@ void insn_get_prefixes(struct insn *insn) prefixes->got =1 ; +return 0 ; + err_out: -return ; +return -ENODATA ; }/** @@ -231,16 +243,25 @@ void insn_get_prefixes(struct insn *insn)* If necessary, first collects any preceding (prefix) bytes. * Sets @insn->opcode.value = opcode1. No effect if @insn->opcode.got * is already 1. +* +* Returns: +* 0: on success +* < 0: on error */ -void insn_get_opcode (struct insn *insn) +int insn_get_opcode (struct insn *insn) {struct insn_field *opcode = &insn->opcode; +int pfx_id, ret;insn_byte_t op; -int pfx_id; +if (opcode->got) -return ; -if (!insn->prefixes.got) -insn_get_prefixes (insn); +return 0 ; + +if (!insn->prefixes.got) { + ret =insn_get_prefixes (insn); +if (ret) +return ret; + }/* Get first opcode */ op =get_next (insn_byte_t, insn);@@ -255,9 +276,13 @@ void insn_get_opcode(struct insn *insn) insn->attr =inat_get_avx_attribute (op, m, p);if ((inat_must_evex (insn->attr) && !insn_is_evex (insn)) || (!inat_accept_vex (insn->attr) && - !inat_is_group (insn->attr))) - insn->attr =0 ;/* This instruction is bad */ - goto end;/* VEX has only 1 byte for opcode */ + !inat_is_group (insn->attr))) { +/* This instruction is bad */ + insn->attr =0 ; +return 1 ; + } +/* VEX has only 1 byte for opcode */ + goto end; } insn->attr =inat_get_opcode_attribute (op);@@ -268,13 +293,18 @@ void insn_get_opcode(struct insn *insn) pfx_id =insn_last_prefix_id (insn); insn->attr =inat_get_escape_attribute (op, pfx_id, insn->attr); } -if (inat_must_vex (insn->attr)) - insn->attr =0 ;/* This instruction is bad */ + +if (inat_must_vex (insn->attr)) { +/* This instruction is bad */ + insn->attr =0 ; +return 1 ; + } end: opcode->got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; }/** @@ -284,15 +314,25 @@ void insn_get_opcode(struct insn *insn)* Populates @insn->modrm and updates @insn->next_byte to point past the * ModRM byte, if any. If necessary, first collects the preceding bytes * (prefixes and opcode(s)). No effect if @insn->modrm.got is already 1. +* +* Returns: +* 0: on success +* < 0: on error */ -void insn_get_modrm (struct insn *insn) +int insn_get_modrm (struct insn *insn) {struct insn_field *modrm = &insn->modrm;insn_byte_t pfx_id, mod; +int ret; +if (modrm->got) -return ; -if (!insn->opcode.got) -insn_get_opcode (insn); +return 0 ; + +if (!insn->opcode.got) { + ret =insn_get_opcode (insn); +if (ret) +return ret; + }if (inat_has_modrm (insn->attr)) { mod =get_next (insn_byte_t, insn);@@ -302,17 +342,22 @@ void insn_get_modrm(struct insn *insn) pfx_id =insn_last_prefix_id (insn); insn->attr =inat_get_group_attribute (mod, pfx_id, insn->attr); -if (insn_is_avx (insn) && !inat_accept_vex (insn->attr)) - insn->attr =0 ;/* This is bad */ +if (insn_is_avx (insn) && !inat_accept_vex (insn->attr)) { +/* Bad insn */ + insn->attr =0 ; +return 1 ; + } } }if (insn->x86_64 &&inat_is_force64 (insn->attr)) insn->opnd_bytes =8 ; + modrm->got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; }@@ -326,11 +371,16 @@ void insn_get_modrm(struct insn *insn)int insn_rip_relative (struct insn *insn) {struct insn_field *modrm = &insn->modrm; +int ret;if (!insn->x86_64)return 0 ; -if (!modrm->got) -insn_get_modrm (insn); + +if (!modrm->got) { + ret =insn_get_modrm (insn); +if (ret) +return ret; + }/* * For rip-relative instructions, the mod field (top 2 bits) * is zero and the r/m field (bottom 3 bits) is 0x5. @@ -344,15 +394,25 @@ int insn_rip_relative(struct insn *insn)* * If necessary, first collects the instruction up to and including the * ModRM byte. +* +* Returns: +* 0: if decoding succeeded +* < 0: otherwise. */ -void insn_get_sib (struct insn *insn) +int insn_get_sib (struct insn *insn) {insn_byte_t modrm; +int ret;if (insn->sib.got) -return ; -if (!insn->modrm.got) -insn_get_modrm (insn); +return 0 ; + +if (!insn->modrm.got) { + ret =insn_get_modrm (insn); +if (ret) +return ret; + } +if (insn->modrm.nbytes) { modrm = (insn_byte_t )insn->modrm.value; if (insn->addr_bytes != 2 &&@@ -363,8 +423,10 @@ void insn_get_sib(struct insn *insn) } insn->sib.got =1 ; +return 0 ; + err_out: -return ; +return -ENODATA ; }@@ -375,15 +437,25 @@ void insn_get_sib(struct insn *insn)* If necessary, first collects the instruction up to and including the * SIB byte. * Displacement value is sign-expanded. +* +* * Returns: +* 0: if decoding succeeded +* < 0: otherwise. */ -void insn_get_displacement (struct insn *insn) +int insn_get_displacement (struct insn *insn) {insn_byte_t mod, rm, base; +int ret;if (insn->displacement.got) -return ; -if (!insn->sib.got) -insn_get_sib (insn); +return 0 ; + +if (!insn->sib.got) { + ret =insn_get_sib (insn); +if (ret) +return ret; + } +if (insn->modrm.nbytes) {/* * Interpreting the modrm byte: @@ -426,12 +498,13 @@ void insn_get_displacement(struct insn *insn) } out: insn->displacement.got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; } -/* Decode moffset16/32/64. Return 0 if failed */ +/* Decode moffset16/32/64. Return a negative value if failed. */ static int __get_moffset (struct insn *insn) {switch (insn->addr_bytes) {@@ -457,10 +530,10 @@ static int __get_moffset(struct insn *insn)return 1 ; err_out: -return 0 ; +return -ENODATA ; } -/* Decode imm v32(Iz). Return 0 if failed */ +/* Decode imm v32(Iz). Return a negative value if failed. */ static int __get_immv32 (struct insn *insn) {switch (insn->opnd_bytes) {@@ -480,10 +553,10 @@ static int __get_immv32(struct insn *insn)return 1 ; err_out: -return 0 ; +return -ENODATA ; } -/* Decode imm v64(Iv/Ov), Return 0 if failed */ +/* Decode imm v64(Iv/Ov). Return a negative value if failed. */ static int __get_immv (struct insn *insn) {switch (insn->opnd_bytes) {@@ -507,11 +580,12 @@ static int __get_immv(struct insn *insn) insn->immediate1.got = insn->immediate2.got =1 ;return 1 ; + err_out: -return 0 ; +return -ENODATA ; } -/* Decode ptr16:16/32(Ap) */ +/* Decode ptr16:16/32(Ap). Return a negative value if failed. */ static int __get_immptr (struct insn *insn) {switch (insn->opnd_bytes) {@@ -534,25 +608,36 @@ static int __get_immptr(struct insn *insn) insn->immediate1.got = insn->immediate2.got =1 ;return 1 ; + err_out: -return 0 ; +return -ENODATA ; }/** -* insn_get_immediate() - Get the immediates of instruction +* insn_get_immediate() - Get the immediate in an instruction * @insn: &struct insn containing instruction * * If necessary, first collects the instruction up to and including the * displacement bytes. * Basically, most of immediates are sign-expanded. Unsigned-value can be -* get by bit masking with ((1 << (nbytes * 8)) - 1) +* computed by bit masking with ((1 << (nbytes * 8)) - 1) +* +* Returns: +* 0: on success +* < 0: on error */ -void insn_get_immediate (struct insn *insn) +int insn_get_immediate (struct insn *insn) { +int ret; +if (insn->immediate.got) -return ; -if (!insn->displacement.got) -insn_get_displacement (insn); +return 0 ; + +if (!insn->displacement.got) { + ret =insn_get_displacement (insn); +if (ret) +return ret; + }if (inat_has_moffset (insn->attr)) {if (!__get_moffset (insn))@@ -605,9 +690,10 @@ void insn_get_immediate(struct insn *insn) } done: insn->immediate.got =1 ; +return 0 ; err_out: -return ; +return -ENODATA ; }/** @@ -616,13 +702,56 @@ void insn_get_immediate(struct insn *insn)* * If necessary, first collects the instruction up to and including the * immediates bytes. -*/ -void insn_get_length (struct insn *insn) +* +* Returns: +* - 0 on success +* - < 0 on error +*/ +int insn_get_length (struct insn *insn) { +int ret; +if (insn->length) -return ; -if (!insn->immediate.got) -insn_get_immediate (insn); +return 0 ; + +if (!insn->immediate.got) { + ret =insn_get_immediate (insn); +if (ret) +return ret; + } + insn->length = (unsigned char )((unsigned long )insn->next_byte - (unsigned long )insn->kaddr); + +return 0 ; +} + +/** +* insn_decode() - Decode an x86 instruction +* @insn: &struct insn to be initialized +* @kaddr: address (in kernel memory) of instruction (or copy thereof) +* @buf_len: length of the insn buffer at @kaddr +* @m: insn mode, see enum insn_mode +* +* Returns: +* 0: if decoding succeeded +* < 0: otherwise. +*/ +int insn_decode (struct insn *insn,const void *kaddr,int buf_len,enum insn_mode m) +{ +int ret; + +if (m ==INSN_MODE_KERN ) +insn_init (insn, kaddr, buf_len,IS_ENABLED (CONFIG_X86_64 )); +else +insn_init (insn, kaddr, buf_len, m ==INSN_MODE_64 ); + + ret =insn_get_length (insn); +if (ret) +return ret; + +if (insn_complete (insn)) +return 0 ; + +return -EINVAL ; }tools/include/linux/kconfig.h new file +73
-0@@ -0,0 +1,73 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _TOOLS_LINUX_KCONFIG_H +#define _TOOLS_LINUX_KCONFIG_H + +/* CONFIG_CC_VERSION_TEXT (Do not delete this comment. See help in Kconfig) */ + +#ifdef CONFIG_CPU_BIG_ENDIAN +#define __BIG_ENDIAN 4321 +#else +#define __LITTLE_ENDIAN 1234 +#endif + +#define __ARG_PLACEHOLDER_1 0, +#define __take_second_arg (__ignored, val, ...) val + +/* +* The use of "&&" / "||" is limited in certain expressions. +* The following enable to calculate "and" / "or" with macro expansion only. +*/ +#define __and (x, y) ___and(x, y) +#define ___and (x, y) ____and(__ARG_PLACEHOLDER_##x, y) +#define ____and (arg1_or_junk, y) __take_second_arg(arg1_or_junk y, 0) + +#define __or (x, y) ___or(x, y) +#define ___or (x, y) ____or(__ARG_PLACEHOLDER_##x, y) +#define ____or (arg1_or_junk, y) __take_second_arg(arg1_or_junk 1, y) + +/* +* Helper macros to use CONFIG_ options in C/CPP expressions. Note that +* these only work with boolean and tristate options. +*/ + +/* +* Getting something that works in C and CPP for an arg that may or may +* not be defined is tricky. Here, if we have "#define CONFIG_BOOGER 1" +* we match on the placeholder define, insert the "0," for arg1 and generate +* the triplet (0, 1, 0). Then the last step cherry picks the 2nd arg (a one). +* When CONFIG_BOOGER is not defined, we generate a (... 1, 0) pair, and when +* the last step cherry picks the 2nd arg, we get a zero. +*/ +#define __is_defined (x) ___is_defined(x) +#define ___is_defined (val) ____is_defined(__ARG_PLACEHOLDER_##val) +#define ____is_defined (arg1_or_junk) __take_second_arg(arg1_or_junk 1, 0) + +/* +* IS_BUILTIN(CONFIG_FOO) evaluates to 1 if CONFIG_FOO is set to 'y', 0 +* otherwise. For boolean options, this is equivalent to +* IS_ENABLED(CONFIG_FOO). +*/ +#define IS_BUILTIN (option) __is_defined(option) + +/* +* IS_MODULE(CONFIG_FOO) evaluates to 1 if CONFIG_FOO is set to 'm', 0 +* otherwise. +*/ +#define IS_MODULE (option) __is_defined(option##_MODULE) + +/* +* IS_REACHABLE(CONFIG_FOO) evaluates to 1 if the currently compiled +* code can call a function defined in code compiled based on CONFIG_FOO. +* This is similar to IS_ENABLED(), but returns false when invoked from +* built-in code when CONFIG_FOO is set to 'm'. +*/ +#define IS_REACHABLE (option) __or(IS_BUILTIN(option), \ + __and(IS_MODULE(option), __is_defined(MODULE))) + +/* +* IS_ENABLED(CONFIG_FOO) evaluates to 1 if CONFIG_FOO is set to 'y' or 'm', +* 0 otherwise. +*/ +#define IS_ENABLED (option) __or(IS_BUILTIN(option), IS_MODULE(option)) + +#endif /* _TOOLS_LINUX_KCONFIG_H */ Signature · 1 line
2.29.2
Signature · 1 line
Masami Hiramatsu <[email protected]>
Re: [PATCH v1 02/19] x86/insn: Add @buf_len param to insn_init() kernel-doc comment
In reply to Borislav PetkovQuoted 4 lines · On Wed, 23 Dec 2020 18:42:16 +0100 Borislav Petkov <[email protected]> wrote:
From: Borislav Petkov <[email protected]>
It wasn't documented so add it. No functional changes.
Thank you for fixing!
Quoted 33 lines
Signed-off-by Borislav Petkov <[email protected]>--- arch/x86/lib/insn.c | 1 + tools/arch/x86/lib/insn.c | 1 + 2 files changed, 2 insertions(+)arch/x86/lib/insn.c +1
-0@@ -37,6 +37,7 @@* insn_init() - initialize struct insn * @insn: &struct insn to be initialized * @kaddr: address (in kernel memory) of instruction (or copy thereof) +* @buf_len: length of the insn buffer at @kaddr * @x86_64: !0 for 64-bit kernel or 64-bit app */ void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64)tools/arch/x86/lib/insn.c +1
-0@@ -37,6 +37,7 @@* insn_init() - initialize struct insn * @insn: &struct insn to be initialized * @kaddr: address (in kernel memory) of instruction (or copy thereof) +* @buf_len: length of the insn buffer at @kaddr * @x86_64: !0 for 64-bit kernel or 64-bit app */ void insn_init (struct insn *insn,const void *kaddr,int buf_len,int x86_64)Signature · 1 line
2.29.2
Signature · 1 line
Masami Hiramatsu <[email protected]>
Re: [PATCH v1 01/19] x86/insn: Rename insn_decode() to insn_decode_regs()
In reply to Borislav PetkovQuoted 5 lines · Borislav Petkov
From: Borislav Petkov <[email protected]>
Rename
insn_decode()toinsn_decode_regs()to denote that it receives regs as param and free the name for a more generic version of the function.
Can we add a preposition in there, e.g. insn_decode_from_regs() or insn_decode_with_regs()? For me, "decode_regs" means "decode the register operands of the instruction".
Re: [PATCH v1 04/19] x86/insn-eval: Handle return values from the decoder
In reply to Borislav PetkovQuoted 27 lines · Borislav Petkov
From: Borislav Petkov <[email protected]>
Now that the different instruction-inspecting functions return a value, test that and return early from callers if error has been encountered.
While at it, do not call
insn_get_modrm()when callinginsn_get_displacement()because latter will make sure to callinsn_get_modrm()if ModRM hasn't been parsed yet.Signed-off-by Borislav Petkov <[email protected]>--- arch/x86/lib/insn-eval.c | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-)arch/x86/lib/insn-eval.c +1
-1@@ -1106,18 +1106,21 @@ static int get_eff_addr_modrm_16(struct insn *insn, struct pt_regs *regs,* @base_offset will have a register, as an offset from the base of pt_regs, * that can be used to resolve the associated segment. * -* -EINVAL on error. +* Negative value on error. */ static int get_eff_addr_sib (struct insn *insn,struct pt_regs *regs,int *base_offset,long *eff_addr)
arch/x86/lib/insn-eval.c static int get_eff_addr_modrm_16(struct insn *insn, struct pt_regs *regs, · line 1121
Quoted 10 lines
arch/x86/lib/insn-eval.c +2
-1{long base, indx;int indx_offset; +int ret;if (insn->addr_bytes !=8 && insn->addr_bytes !=4 )return -EINVAL ; -insn_get_modrm (insn); + ret =insn_get_modrm (insn);
This patch is incomplete/inconsistent, and arguably wrong.
- get_eff_addr_reg() and get_eff_addr_modrm() still ignore the return of insn_get_modrm() after this patch.
- Calling insn_get_modrm() from get_eff_addr_sib() is unnecessary (unless the caller passed uninitialized garbage in @insn) as get_eff_addr_sib() is called if and only if sib.nbytes!=0, and sib.nbytes can be non-zero if and only if the modrm and sib have been got.
- get_addr_ref_16() does insn_get_displacement, i.e. guarantees the modrm is parsed, while the 32/64 variants do not.
What about adding a prereq patch (or three) to call insn_get_displacement() in insn_get_addr_ref() prior to switching on insn->addr_bytes? Then the various internal helpers could be changed to either omit the sanity checks entirely or WARN on invalid calls? Or better yet, add an INSN_WARN_ON() macro that compiles out the checks by default? E.g. something like:
arch/x86/lib/insn-eval.c +0 -0
@@ -928,12 +928,8 @@ static int get_seg_base_limit(struct insn *insn, struct pt_regs *regs,
arch/x86/lib/insn-eval.c +13 -30
85 lines not on this page · raw message
Borislav Petkov
maintainerRe: [PATCH v1 04/19] x86/insn-eval: Handle return values from the decoder
Quoted 4 lines · Sean Christopherson
This patch is incomplete/inconsistent, and arguably wrong.
-
get_eff_addr_reg()andget_eff_addr_modrm()still ignore the return ofinsn_get_modrm()after this patch.
Ah, will fix, thx.
Quoted 5 lines
- Calling
insn_get_modrm()fromget_eff_addr_sib()is unnecessary (unless the caller passed uninitialized garbage in @insn) asget_eff_addr_sib()is called if and only if sib.nbytes!=0, and sib.nbytes can be non-zero if and only if the modrm and sib have been got.
Quoted 8 lines
-
get_addr_ref_16()doesinsn_get_displacement, i.e. guarantees the modrm is parsed, while the 32/64 variants do not.What about adding a prereq patch (or three) to call
insn_get_displacement()ininsn_get_addr_ref()prior to switching oninsn->addr_bytes? Then the various internal helpers could be changed to either omit the sanity checks entirely or WARN on invalid calls? Or better yet, add anINSN_WARN_ON()macro that compiles out the checks by default? E.g. something like:
So the idea is one construction site at a time (that's a German saying :)).
This set deals with whacking the insn decoder into returning proper error/success values. The next set should do simplifications/fixes/cleanups/whatever but not all at the same time for obvious reasons.
So yeah, I'm all for omitting useless code but let's do that ontop.
Thx.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteRe: [PATCH v1 11/19] x86/sev-es: Convert to insn_decode()
In reply to Borislav PetkovQuoted 6 lines · Borislav Petkov
Quoted 5 lines · kernel test robot
If you fix the issue, kindly add following tag as appropriate
Reported-by kernel test robot <[email protected]>All warnings (new ones prefixed by >>):
Quoted 8 lines
Quoted 3 lines
Quoted 1 line
Quoted 1 line
arch/x86/kernel/sev-es.c:258:7: warning: variable 'ret' is used uninitialized whenever 'if' condition is false [-Wsometimes-uninitialized]if (!insn_decode_regs(&ctxt->insn, ctxt->regs, buffer, res)) ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Yeah, good catch, thanks for reporting.
Frankly, the readability and "extensiblity" of that function can be improved by splitting the two cases (diff ontop):
Alternatively, could the kernel case use insn_decode_regs()? If vc_fetch_insn_kernel() were also modified to mirror insn_fetch_from_user(), the two code paths could be unified except for the the fetch and the PFEC. E.g.
static int vc_fetch_insn_kernel(struct es_em_ctxt *ctxt,
unsigned char *buffer)
{
if (copy_from_kernel_nofault(buffer, (unsigned char *)ctxt->regs->ip, MAX_INSN_SIZE))
return 0;
return MAX_INSN_SIZE;
}static enum es_result vc_decode_insn(struct es_em_ctxt *ctxt)
{
char buffer[MAX_INSN_SIZE];
int nbytes;
if (user_mode(ctxt->regs))
nbytes = insn_fetch_from_user(ctxt->regs, buffer);
else
nbytes = vc_fetch_insn_kernel(ctxt, buffer);
if (!nbytes) {
ctxt->fi.vector = X86_TRAP_PF;
ctxt->fi.error_code = X86_PF_INSTR;
if (user_mode(ctxt->regs))
ctxt->fi.error_code |= X86_PF_USER;
ctxt->fi.cr2 = ctxt->regs->ip;
return ES_EXCEPTION;
}
if (!insn_decode_regs(&ctxt->insn, ctxt->regs, buffer, nbytes))
return ES_DECODE_FAILED;
return ctxt->insn.immediate.got ? ES_OK : ES_DECODE_FAILED;
}Borislav Petkov
maintainerRe: [PATCH v1 01/19] x86/insn: Rename insn_decode() to insn_decode_regs()
In reply to Sean ChristophersonQuoted 3 lines · Sean Christopherson
Can we add a preposition in there, e.g.
insn_decode_from_regs()orinsn_decode_with_regs()? For me, "decode_regs" means "decode the register operands of the instruction".
"...from_regs" it is.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteBorislav Petkov
maintainerQuoted 1 line · Masami Hiramatsu
BTW,
insn_decode()can return-EINVALif !insn_complete(), is that OK?
It does with this change. Or are you asking whether it returning -EINVAL in that case is ok?
I don't see why not - this way callers can differentiate where it failed
- at fetching bytes with -ENODATA or it wasn't decoded completely - -EINVAL.
Quoted 5 lines
I think tools clone code must not use
INSN_MODE_KERNbecause the tools may not use kernelKconfig.Hmm, this may be better to make a different patch to introduce a NOSYNC tag for sync checker in the tools. Something like;
I'd actually prefer this:
tools/arch/x86/include/asm/insn.h +0 -2
@@ -98,8 +98,6 @@ extern int insn_get_length(struct insn *insn);enum insn_mode {INSN_MODE_32 ,INSN_MODE_64 , -/* Mode is determined by the current kernel build. */ -INSN_MODE_KERN ,INSN_NUM_MODES , };
so that when a tool does use INSN_MODE_KERN, it would fail building:
In file included from util/intel-pt-decoder/intel-pt-insn-decoder.c:15:util/intel-pt-decoder/../../../arch/x86/lib/insn.c: In function ‘insn_decode’:util/intel-pt-decoder/../../../arch/x86/lib/insn.c:751:11: error: ‘INSN_MODE_KERN’ undeclared (first use in this function); did you mean ‘INSN_MODE_64’?
751 | if (m == INSN_MODE_KERN)
| ^~~~~~~~~~~~~~
| INSN_MODE_64util/intel-pt-decoder/../../../arch/x86/lib/insn.c:751:11: note: each undeclared identifier is reported only once for each function it appears in
LD arch/perf-in.outil/intel-pt-decoder/intel-pt-insn-decoder.c: In function ‘intel_pt_get_insn’:util/intel-pt-decoder/intel-pt-insn-decoder.c:163:37: error: ‘INSN_MODE_KERN’ undeclared (first use in this function); did you mean ‘INSN_MODE_64’?
163 | ret = insn_decode(&insn, buf, len, INSN_MODE_KERN);
| ^~~~~~~~~~~~~~
| INSN_MODE_64Thx.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteMasami Hiramatsu
maintainerQuoted 9 lines · On Tue, 29 Dec 2020 21:06:54 +0100 Borislav Petkov <[email protected]> wrote:
Quoted 1 line · Masami Hiramatsu
BTW,
insn_decode()can return-EINVALif !insn_complete(), is that OK?It does with this change. Or are you asking whether it returning
-EINVALin that case is ok?I don't see why not - this way callers can differentiate where it failed
- at fetching bytes with-ENODATAor it wasn't decoded completely --EINVAL.
Ah, I got it.
Quoted 14 lines
Quoted 6 lines
I think tools clone code must not use
INSN_MODE_KERNbecause the tools may not use kernelKconfig.Hmm, this may be better to make a different patch to introduce a NOSYNC tag for sync checker in the tools. Something like;
I'd actually prefer this:
tools/arch/x86/include/asm/insn.h +0
-0
tools/arch/x86/include/asm/insn.h extern int insn_get_length(struct insn *insn); · line 102
Quoted 7 lines
tools/arch/x86/include/asm/insn.h +0
-2@@ -98,8 +98,6 @@ extern int insn_get_length(struct insn *insn);enum insn_mode {INSN_MODE_32 ,INSN_MODE_64 , -/* Mode is determined by the current kernel build. */ -INSN_MODE_KERN ,INSN_NUM_MODES , };
Agreed. This is much simpler.
Maybe I need to replace it with dummy lines but it is possible.
Quoted 10 lines
so that when a tool does use
INSN_MODE_KERN, it would fail building:In file included from
util/intel-pt-decoder/intel-pt-insn-decoder.c:15:util/intel-pt-decoder/../../../arch/x86/lib/insn.c: In function ‘insn_decode’:util/intel-pt-decoder/../../../arch/x86/lib/insn.c:751:11: error: ‘INSN_MODE_KERN’ undeclared (first use in this function); did you mean ‘INSN_MODE_64’?751 | if (m == INSN_MODE_KERN) | ^~~~~~~~~~~~~~ | INSN_MODE_64
This part is OK. I can replace it with dummy lines.
Quoted 7 lines
util/intel-pt-decoder/../../../arch/x86/lib/insn.c:751:11: note: each undeclared identifier is reported only once for each function it appears in
LDarch/perf-in.outil/intel-pt-decoder/intel-pt-insn-decoder.c: In function ‘intel_pt_get_insn’:util/intel-pt-decoder/intel-pt-insn-decoder.c:163:37: error: ‘INSN_MODE_KERN’ undeclared (first use in this function); did you mean ‘INSN_MODE_64’?163 | ret = insn_decode(&insn, buf, len, INSN_MODE_KERN); | ^~~~~~~~~~~~~~ | INSN_MODE_64
But in [17/19], your patch seems not using INSN_MODE_KERN there.
tools/perf/util/intel-pt-decoder/intel-pt-insn-decoder.c +5 -3
@@ -158,11 +158,13 @@ int intel_pt_get_insn(const unsigned char *buf, size_t len, int x86_64, struct intel_pt_insn *intel_pt_insn) {struct insn insn; +int ret; -insn_init (&insn, buf, len, x86_64); -insn_get_length (&insn); -if (!insn_complete (&insn) || insn.length > len) + ret =insn_decode (&insn, buf, len, + x86_64 ?INSN_MODE_64 :INSN_MODE_32 ); +if (ret <0 || insn.length > len)return -1 ; +intel_pt_insn_decoder (&insn, intel_pt_insn);if (insn.length <INTEL_PT_INSN_BUF_SZ )memcpy (intel_pt_insn->buf, buf, insn.length);
Thank you,
Signature · 1 line
Masami Hiramatsu <[email protected]>
Borislav Petkov
maintainerQuoted 1 line · Masami Hiramatsu
Maybe I need to replace it with dummy lines but it is possible.
Dummy lines like "IGNORE DURING CHECK" or something like that?
Quoted 1 line
But in [17/19], your patch seems not using
INSN_MODE_KERNthere.
I replaced it only locally just so that I can cause the build error and show you what mean.
I still haven't thought about what do to exactly there wrt making sync-check.sh happy but the aspect of failing the build is a nice one.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquettePeter Zijlstra
maintainerRe: [PATCH v1 06/19] perf/x86/intel/ds: Check insn_get_length() retval
In reply to Borislav PetkovQuoted 20 lines · Borislav Petkov
From: Borislav Petkov <[email protected]>
intel_pmu_pebs_fixup_ip()needs only the insn length so use the appropriate helper instead of a full decode. A full decode differs only in runninginsn_complete()on the decoded insn but that is not needed here.Signed-off-by Borislav Petkov <[email protected]>--- arch/x86/events/intel/ds.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)arch/x86/events/intel/ds.c +0
-0@@ -1265,14 +1265,14 @@ static int intel_pmu_pebs_fixup_ip(struct pt_regs *regs) is_64bit =kernel_ip (to) ||any_64bit_mode (regs);#endif insn_init (&insn, kaddr, size, is_64bit);
arch/x86/events/intel/ds.c static int intel_pmu_pebs_fixup_ip(struct pt_regs *regs) · line 1275
Quoted 10 lines
arch/x86/events/intel/ds.c +2
-2-insn_get_length (&insn); +/* * Make sure there was not a problem decoding the * instruction and getting the length. This is * doubly important because we have an infinite * loop if insn.length=0. */ -if (!insn.length) +if (insn_get_length (&insn) || !insn.length)
Do we really still need the !insn.length? That is, it *should* be impossible to not fail insn_get_length() and still have a 0 length, seeing how x86 doesn't have 0 length instructions.
Masami Hiramatsu
maintainerQuoted 2 lines · On Wed, 30 Dec 2020 10:28:33 +0100 Borislav Petkov <[email protected]> wrote:
I still haven't thought about what do to exactly there wrt making
sync-check.shhappy but the aspect of failing the build is a nice one.
So I think it is possible to introduce a keyword in a comment for ignoring sync check something like below. This will allow us a generic pattern matching.
The keyword is just an example, "no-sync-check" etc. is OK.
What would you think about it?
Thank you,
arch/x86/include/asm/inat.h +1 -1
@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/inat_types.h> +#include <asm/inat_types.h> /* Different from tools */ /* * Internal bits. Don't use bitmasks directly, because these bits are
arch/x86/include/asm/insn.h +1 -1
@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include <asm/inat.h> +#include <asm/inat.h> /* Different from tools */ struct insn_field { union {
tools/arch/x86/include/asm/inat.h +1 -1
@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "inat_types.h" +#include "inat_types.h" /* Different from kernel */ /* * Internal bits. Don't use bitmasks directly, because these bits are
tools/arch/x86/include/asm/insn.h +1 -1
@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include "inat.h" +#include "inat.h" /* Different from kernel */ struct insn_field { union {
tools/perf/check-headers.sh +2 -2
@@ -137,8 +137,8 @@ check include/uapi/linux/mman.h '-I "^#include <\(uapi/\)*asm/mman.h>"' check include/linux/build_bug.h '-I "^#\(ifndef\|endif\)\( \/\/\)* static_assert$"' check include/linux/ctype.h '-I "isdigit("' check lib/ctype.c '-I "^EXPORT_SYMBOL" -I "^#include <linux/export.h>" -B' -check arch/x86/include/asm/inat.h '-I "^#include [\"<]\(asm/\)*inat_types.h[\">]"' -check arch/x86/include/asm/insn.h '-I "^#include [\"<]\(asm/\)*inat.h[\">]"' +check arch/x86/include/asm/inat.h '-I "^.*/\* Different from \(tools\|kernel\) \*/"' +check arch/x86/include/asm/insn.h '-I "^.*/\* Different from \(tools\|kernel\) \*/"' check arch/x86/lib/inat.c '-I "^#include [\"<]\(../include/\)*asm/insn.h[\">]"' check arch/x86/lib/insn.c '-I "^#include [\"<]\(../include/\)*asm/in\(at\|sn\).h[\">]" -I "^#include [\"<]\(../include/\)*asm/emulate_prefix.h[\">]"'
Signature · 1 line
Masami Hiramatsu <[email protected]>
Borislav Petkov
maintainerQuoted 7 lines · Masami Hiramatsu
So I think it is possible to introduce a keyword in a comment for ignoring sync check something like below. This will allow us a generic pattern matching.
The keyword is just an example, "no-sync-check" etc. is OK.
What would you think about it?
Yeah, I'd prefer a single keyword which to slap everywhere, see below. The patch is only for demonstration, though, it is not complete.
And while playing with that after having commented out INSN_MODE_KERN in the tools/ version, I realized that the build would always fail because insn.c references it:
In file included from arch/x86/decode.c:12:arch/x86/../../../arch/x86/lib/insn.c: In function ‘insn_decode’:arch/x86/../../../arch/x86/lib/insn.c:751:11: error: ‘INSN_MODE_KERN’ undeclared (first use in this function); did you mean ‘INSN_MODE_64’?
751 | if (m == INSN_MODE_KERN)
| ^~~~~~~~~~~~~~
| INSN_MODE_64and making that work would turn pretty ugly because I wanna avoid slapping that __ignore_sync_check__ or whatever on more than one line.
So I need to think about a better solution here...
---
arch/x86/include/asm/inat.h +1 -1
@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/inat_types.h> +#include <asm/inat_types.h> /* __ignore_sync_check__ */ /* * Internal bits. Don't use bitmasks directly, because these bits are
arch/x86/include/asm/insn.h +2 -2
@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include <asm/inat.h> +#include <asm/inat.h> /* __ignore_sync_check__ */ struct insn_field { union {
@@ -99,7 +99,7 @@ enum insn_mode {INSN_MODE_32 ,INSN_MODE_64 ,/* Mode is determined by the current kernel build. */ -INSN_MODE_KERN , +INSN_MODE_KERN ,/* __ignore_sync_check__ */ INSN_NUM_MODES, };
arch/x86/lib/inat.c +1 -1
@@ -4,7 +4,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/insn.h> +#include <asm/insn.h> /* __ignore_sync_check__ */ /* Attribute tables are generated from opcode map */ #include "inat-tables.c"
arch/x86/lib/insn.c +3 -3
@@ -10,13 +10,13 @@#else #include <string.h> #endif -#include <asm/inat.h> -#include <asm/insn.h> +#include <asm/inat.h> /*__ignore_sync_check__ */ +#include <asm/insn.h> /* __ignore_sync_check__ */ #include <linux/errno.h> #include <linux/kconfig.h> -#include <asm/emulate_prefix.h> +#include <asm/emulate_prefix.h> /* __ignore_sync_check__ */ /* Verify next sizeof(t) bytes can be on the same instruction */ #define validate_next (t, insn, n) \
tools/arch/x86/include/asm/inat.h +1 -1
@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "inat_types.h" +#include "inat_types.h" /* __ignore_sync_check__ */ /* * Internal bits. Don't use bitmasks directly, because these bits are
tools/arch/x86/include/asm/insn.h +2 -2
@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include "inat.h" +#include "inat.h" /* __ignore_sync_check__ */ struct insn_field { union {
@@ -99,7 +99,7 @@ enum insn_mode {INSN_MODE_32 ,INSN_MODE_64 ,/* Mode is determined by the current kernel build. */ -INSN_MODE_KERN , +/* INSN_MODE_KERN, __ignore_sync_check__ */ INSN_NUM_MODES, };
tools/arch/x86/lib/inat.c +1 -1
@@ -4,7 +4,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "../include/asm/insn.h" +#include "../include/asm/insn.h" /* __ignore_sync_check__ */ /* Attribute tables are generated from opcode map */ #include "inat-tables.c"
tools/arch/x86/lib/insn.c +3 -3
@@ -10,13 +10,13 @@#else #include <string.h> #endif -#include "../include/asm/inat.h" -#include "../include/asm/insn.h" +#include "../include/asm/inat.h" /* __ignore_sync_check__ */ +#include "../include/asm/insn.h" /* __ignore_sync_check__ */ #include <linux/errno.h> #include <linux/kconfig.h> -#include "../include/asm/emulate_prefix.h" +#include "../include/asm/emulate_prefix.h" /* __ignore_sync_check__ */ /* Verify next sizeof(t) bytes can be on the same instruction */ #define validate_next (t, insn, n) \
tools/perf/check-headers.sh +11 -4
@@ -75,6 +75,13 @@ include/uapi/asm-generic/mman-common.h include/uapi/asm-generic/unistd.h ' +SYNC_CHECK_FILES=' +arch/x86/include/asm/inat.h +arch/x86/include/asm/insn.h +arch/x86/lib/inat.c +arch/x86/lib/insn.c +' + # These copies are under tools/perf/trace/beauty/ as they are not used to in # building object files only by scripts in tools/perf/trace/beauty/ to generate # tables that then gets included in .c files for things like id->string syscall
@@ -129,6 +136,10 @@ for i in $FILES; do check $i -B done +for i in $SYNC_CHECK_FILES; do + check $i '-I "^.*\/*.*__ignore_sync_check__ \*/.*$"' +done + # diff with extra ignore lines check arch/x86/lib/memcpy_64.S '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memcpy_\(erms\|orig\))"' check arch/x86/lib/memset_64.S '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memset_\(erms\|orig\))"'
@@ -137,10 +148,6 @@ check include/uapi/linux/mman.h '-I "^#include <\(uapi/\)*asm/mman.h>"' check include/linux/build_bug.h '-I "^#\(ifndef\|endif\)\( \/\/\)* static_assert$"' check include/linux/ctype.h '-I "isdigit("' check lib/ctype.c '-I "^EXPORT_SYMBOL" -I "^#include <linux/export.h>" -B' -check arch/x86/include/asm/inat.h '-I "^#include [\"<]\(asm/\)*inat_types.h[\">]"' -check arch/x86/include/asm/insn.h '-I "^#include [\"<]\(asm/\)*inat.h[\">]"' -check arch/x86/lib/inat.c '-I "^#include [\"<]\(../include/\)*asm/insn.h[\">]"' -check arch/x86/lib/insn.c '-I "^#include [\"<]\(../include/\)*asm/in\(at\|sn\).h[\">]" -I "^#include [\"<]\(../include/\)*asm/emulate_prefix.h[\">]"' # diff non-symmetric files check_2 tools/perf/arch/x86/entry/syscalls/syscall_64.tbl arch/x86/entry/syscalls/syscall_64.tbl
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteMasami Hiramatsu
maintainerQuoted 11 lines · On Fri, 8 Jan 2021 19:59:50 +0100 Borislav Petkov <[email protected]> wrote:
Quoted 7 lines · Masami Hiramatsu
So I think it is possible to introduce a keyword in a comment for ignoring sync check something like below. This will allow us a generic pattern matching.
The keyword is just an example, "no-sync-check" etc. is OK.
What would you think about it?
Yeah, I'd prefer a single keyword which to slap everywhere, see below. The patch is only for demonstration, though, it is not complete.
Yes, that looks good to me too.
Quoted 8 lines
And while playing with that after having commented out
INSN_MODE_KERNin thetools/version, I realized that the build would always fail becauseinsn.creferences it:In file included from
arch/x86/decode.c:12:arch/x86/../../../arch/x86/lib/insn.c: In function ‘insn_decode’:arch/x86/../../../arch/x86/lib/insn.c:751:11: error: ‘INSN_MODE_KERN’ undeclared (first use in this function); did you mean ‘INSN_MODE_64’?
Quoted 8 lines
751 | if (m == INSN_MODE_KERN) | ^~~~~~~~~~~~~~ | INSN_MODE_64and making that work would turn pretty ugly because I wanna avoid slapping that
__ignore_sync_check__or whatever on more than one line.So I need to think about a better solution here...
Hmm, instead of removing INSN_MODE_KERN, if you just return an error, it will change one line.
if (m == INSN_MODE_KERN) return -EINVAL; /* __ignore_sync_check__ */ else insn_init(insn, kaddr, buf_len, m == INSN_MODE_64);
Or, add one definition before that line.
#define INSN_MODE_KERN -1 /* __ignore_sync_check__ */
Thank you,
Quoted 186 lines
---
arch/x86/include/asm/inat.h +1
-1@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/inat_types.h> +#include <asm/inat_types.h> /* __ignore_sync_check__ */ /* * Internal bits. Don't use bitmasks directly, because these bits are arch/x86/include/asm/insn.h +2
-2@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include <asm/inat.h> +#include <asm/inat.h> /* __ignore_sync_check__ */ struct insn_field { union {@@ -99,7 +99,7 @@ enum insn_mode {INSN_MODE_32 ,INSN_MODE_64 ,/* Mode is determined by the current kernel build. */ -INSN_MODE_KERN , +INSN_MODE_KERN ,/* __ignore_sync_check__ */ INSN_NUM_MODES, };arch/x86/lib/inat.c +1
-1@@ -4,7 +4,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/insn.h> +#include <asm/insn.h> /* __ignore_sync_check__ */ /* Attribute tables are generated from opcode map */ #include "inat-tables.c" arch/x86/lib/insn.c +3
-3@@ -10,13 +10,13 @@#else #include <string.h> #endif -#include <asm/inat.h> -#include <asm/insn.h> +#include <asm/inat.h> /*__ignore_sync_check__ */ +#include <asm/insn.h> /* __ignore_sync_check__ */ #include <linux/errno.h> #include <linux/kconfig.h> -#include <asm/emulate_prefix.h> +#include <asm/emulate_prefix.h> /* __ignore_sync_check__ */ /* Verify next sizeof(t) bytes can be on the same instruction */ #define validate_next (t, insn, n) \tools/arch/x86/include/asm/inat.h +1
-1@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "inat_types.h" +#include "inat_types.h" /* __ignore_sync_check__ */ /* * Internal bits. Don't use bitmasks directly, because these bits are tools/arch/x86/include/asm/insn.h +2
-2@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include "inat.h" +#include "inat.h" /* __ignore_sync_check__ */ struct insn_field { union {@@ -99,7 +99,7 @@ enum insn_mode {INSN_MODE_32 ,INSN_MODE_64 ,/* Mode is determined by the current kernel build. */ -INSN_MODE_KERN , +/* INSN_MODE_KERN, __ignore_sync_check__ */ INSN_NUM_MODES, };tools/arch/x86/lib/inat.c +1
-1@@ -4,7 +4,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "../include/asm/insn.h" +#include "../include/asm/insn.h" /* __ignore_sync_check__ */ /* Attribute tables are generated from opcode map */ #include "inat-tables.c" tools/arch/x86/lib/insn.c +3
-3@@ -10,13 +10,13 @@#else #include <string.h> #endif -#include "../include/asm/inat.h" -#include "../include/asm/insn.h" +#include "../include/asm/inat.h" /* __ignore_sync_check__ */ +#include "../include/asm/insn.h" /* __ignore_sync_check__ */ #include <linux/errno.h> #include <linux/kconfig.h> -#include "../include/asm/emulate_prefix.h" +#include "../include/asm/emulate_prefix.h" /* __ignore_sync_check__ */ /* Verify next sizeof(t) bytes can be on the same instruction */ #define validate_next (t, insn, n) \tools/perf/check-headers.sh +11
-4@@ -75,6 +75,13 @@ include/uapi/asm-generic/mman-common.h include/uapi/asm-generic/unistd.h ' +SYNC_CHECK_FILES=' +arch/x86/include/asm/inat.h +arch/x86/include/asm/insn.h +arch/x86/lib/inat.c +arch/x86/lib/insn.c +' + # These copies are under tools/perf/trace/beauty/ as they are not used to in # building object files only by scripts in tools/perf/trace/beauty/ to generate # tables that then gets included in .c files for things like id->string syscall@@ -129,6 +136,10 @@ for i in $FILES; do check $i -B done +for i in $SYNC_CHECK_FILES; do + check $i '-I "^.*\/*.*__ignore_sync_check__ \*/.*$"' +done + # diff with extra ignore lines check arch/x86/lib/memcpy_64.S '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memcpy_\(erms\|orig\))"' check arch/x86/lib/memset_64.S '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memset_\(erms\|orig\))"'@@ -137,10 +148,6 @@ check include/uapi/linux/mman.h '-I "^#include <\(uapi/\)*asm/mman.h>"' check include/linux/build_bug.h '-I "^#\(ifndef\|endif\)\( \/\/\)* static_assert$"' check include/linux/ctype.h '-I "isdigit("' check lib/ctype.c '-I "^EXPORT_SYMBOL" -I "^#include <linux/export.h>" -B' -check arch/x86/include/asm/inat.h '-I "^#include [\"<]\(asm/\)*inat_types.h[\">]"' -check arch/x86/include/asm/insn.h '-I "^#include [\"<]\(asm/\)*inat.h[\">]"' -check arch/x86/lib/inat.c '-I "^#include [\"<]\(../include/\)*asm/insn.h[\">]"' -check arch/x86/lib/insn.c '-I "^#include [\"<]\(../include/\)*asm/in\(at\|sn\).h[\">]" -I "^#include [\"<]\(../include/\)*asm/emulate_prefix.h[\">]"' # diff non-symmetric files check_2 tools/perf/arch/x86/entry/syscalls/syscall_64.tbl arch/x86/entry/syscalls/syscall_64.tblSignature · 5 lines
-- Regards/Gruss, Boris. https://people.kernel.org/tglx/notes-about-netiquette
Signature · 1 line
Masami Hiramatsu <[email protected]>
Borislav Petkov
maintainerQuoted 3 lines · Masami Hiramatsu
Or, add one definition before that line.
#define
INSN_MODE_KERN-1 /*__ignore_sync_check__*/
I like that idea, thanks! And it seems to work:
---
arch/x86/include/asm/inat.h +1 -1
@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/inat_types.h> +#include <asm/inat_types.h> /* __ignore_sync_check__ */ /* * Internal bits. Don't use bitmasks directly, because these bits are
arch/x86/include/asm/insn.h +1 -1
@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include <asm/inat.h> +#include <asm/inat.h> /* __ignore_sync_check__ */ struct insn_field { union {
arch/x86/lib/inat.c +1 -1
@@ -4,7 +4,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include <asm/insn.h> +#include <asm/insn.h> /* __ignore_sync_check__ */ /* Attribute tables are generated from opcode map */ #include "inat-tables.c"
arch/x86/lib/insn.c +5 -3
@@ -10,13 +10,13 @@#else #include <string.h> #endif -#include <asm/inat.h> -#include <asm/insn.h> +#include <asm/inat.h> /*__ignore_sync_check__ */ +#include <asm/insn.h> /* __ignore_sync_check__ */ #include <linux/errno.h> #include <linux/kconfig.h> -#include <asm/emulate_prefix.h> +#include <asm/emulate_prefix.h> /* __ignore_sync_check__ */ /* Verify next sizeof(t) bytes can be on the same instruction */ #define validate_next (t, insn, n) \
@@ -748,6 +748,8 @@ int insn_decode(struct insn *insn, const void *kaddr, int buf_len, enum insn_mod {int ret; +/* #define INSN_MODE_KERN -1 __ignore_sync_check__ mode is only valid in the kernel */ +if (m ==INSN_MODE_KERN )insn_init (insn, kaddr, buf_len,IS_ENABLED (CONFIG_X86_64 ));else
tools/arch/x86/include/asm/inat.h +1 -1
@@ -6,7 +6,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "inat_types.h" +#include "inat_types.h" /* __ignore_sync_check__ */ /* * Internal bits. Don't use bitmasks directly, because these bits are
tools/arch/x86/include/asm/insn.h +1 -1
@@ -8,7 +8,7 @@*/ /* insn_attr_t is defined in inat.h */ -#include "inat.h" +#include "inat.h" /* __ignore_sync_check__ */ struct insn_field { union {
tools/arch/x86/lib/inat.c +1 -1
@@ -4,7 +4,7 @@* * Written by Masami Hiramatsu <[email protected]> */ -#include "../include/asm/insn.h" +#include "../include/asm/insn.h" /* __ignore_sync_check__ */ /* Attribute tables are generated from opcode map */ #include "inat-tables.c"
tools/arch/x86/lib/insn.c +5 -3
@@ -10,13 +10,13 @@#else #include <string.h> #endif -#include "../include/asm/inat.h" -#include "../include/asm/insn.h" +#include "../include/asm/inat.h" /* __ignore_sync_check__ */ +#include "../include/asm/insn.h" /* __ignore_sync_check__ */ #include <linux/errno.h> #include <linux/kconfig.h> -#include "../include/asm/emulate_prefix.h" +#include "../include/asm/emulate_prefix.h" /* __ignore_sync_check__ */ /* Verify next sizeof(t) bytes can be on the same instruction */ #define validate_next (t, insn, n) \
@@ -748,6 +748,8 @@ int insn_decode(struct insn *insn, const void *kaddr, int buf_len, enum insn_mod {int ret; +#define INSN_MODE_KERN -1/* __ignore_sync_check__ mode is only valid in the kernel */ +if (m ==INSN_MODE_KERN )insn_init (insn, kaddr, buf_len,IS_ENABLED (CONFIG_X86_64 ));else
tools/objtool/sync-check.sh +13 -4
@@ -16,11 +16,14 @@ arch/x86/include/asm/emulate_prefix.h arch/x86/lib/x86-opcode-map.txt arch/x86/tools/gen-insn-attr-x86.awk include/linux/static_call_types.h -arch/x86/include/asm/inat.h -I '^#include [\"<]\(asm/\)*inat_types.h[\">]' -arch/x86/include/asm/insn.h -I '^#include [\"<]\(asm/\)*inat.h[\">]' -arch/x86/lib/inat.c -I '^#include [\"<]\(../include/\)*asm/insn.h[\">]' -arch/x86/lib/insn.c -I '^#include [\"<]\(../include/\)*asm/in\(at\|sn\).h[\">]' -I '^#include [\"<]\(../include/\)*asm/emulate_prefix.h[\">]' " + +SYNC_CHECK_FILES=' +arch/x86/include/asm/inat.h +arch/x86/include/asm/insn.h +arch/x86/lib/inat.c +arch/x86/lib/insn.c +' fi check_2 () {
@@ -63,3 +66,9 @@ while read -r file_entry; do done <<EOF $FILES EOF + +if [ "$SRCARCH" = "x86" ]; then + for i in $SYNC_CHECK_FILES; do + check $i '-I "^.*\/\*.*__ignore_sync_check__.*\*\/.*$"' + done +fi
tools/perf/check-headers.sh +11 -4
@@ -75,6 +75,13 @@ include/uapi/asm-generic/mman-common.h include/uapi/asm-generic/unistd.h ' +SYNC_CHECK_FILES=' +arch/x86/include/asm/inat.h +arch/x86/include/asm/insn.h +arch/x86/lib/inat.c +arch/x86/lib/insn.c +' + # These copies are under tools/perf/trace/beauty/ as they are not used to in # building object files only by scripts in tools/perf/trace/beauty/ to generate # tables that then gets included in .c files for things like id->string syscall
@@ -129,6 +136,10 @@ for i in $FILES; do check $i -B done +for i in $SYNC_CHECK_FILES; do + check $i '-I "^.*\/\*.*__ignore_sync_check__.*\*\/.*$"' +done + # diff with extra ignore lines check arch/x86/lib/memcpy_64.S '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memcpy_\(erms\|orig\))"' check arch/x86/lib/memset_64.S '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memset_\(erms\|orig\))"'
@@ -137,10 +148,6 @@ check include/uapi/linux/mman.h '-I "^#include <\(uapi/\)*asm/mman.h>"' check include/linux/build_bug.h '-I "^#\(ifndef\|endif\)\( \/\/\)* static_assert$"' check include/linux/ctype.h '-I "isdigit("' check lib/ctype.c '-I "^EXPORT_SYMBOL" -I "^#include <linux/export.h>" -B' -check arch/x86/include/asm/inat.h '-I "^#include [\"<]\(asm/\)*inat_types.h[\">]"' -check arch/x86/include/asm/insn.h '-I "^#include [\"<]\(asm/\)*inat.h[\">]"' -check arch/x86/lib/inat.c '-I "^#include [\"<]\(../include/\)*asm/insn.h[\">]"' -check arch/x86/lib/insn.c '-I "^#include [\"<]\(../include/\)*asm/in\(at\|sn\).h[\">]" -I "^#include [\"<]\(../include/\)*asm/emulate_prefix.h[\">]"' # diff non-symmetric files check_2 tools/perf/arch/x86/entry/syscalls/syscall_64.tbl arch/x86/entry/syscalls/syscall_64.tbl
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteBorislav Petkov
maintainerRe: [PATCH v1 06/19] perf/x86/intel/ds: Check insn_get_length() retval
In reply to Peter ZijlstraQuoted 3 lines · Peter Zijlstra
Do we really still need the !insn.length? That is, it *should* be impossible to not fail
insn_get_length()and still have a 0 length, seeing how x86 doesn't have 0 length instructions.
I was responding to the "doubly important" thing in the comment scarying me about an infinite loop and thus left the length check in, in case the insn decoder would have a bug and return success but still have insn.length 0.
With the length check the endless loop won't happen but let's be brave here ... :-)
So removed.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteBorislav Petkov
maintainerRe: [PATCH v1 11/19] x86/sev-es: Convert to insn_decode()
In reply to Sean ChristophersonQuoted 3 lines · Sean Christopherson
Alternatively, could the kernel case use
insn_decode_regs()? Ifvc_fetch_insn_kernel()were also modified to mirrorinsn_fetch_from_user(), the two code paths could be unified except for the the fetch and the PFEC. E.g.
Personal Firearms Eligibility Check?
In any case, I prefer simple, easy to follow code at a quick glance. Stuff like...
Quoted 11 lines
static int vc_fetch_insn_kernel(struct
es_em_ctxt*ctxt,
unsigned char *buffer){ if (copy_from_kernel_nofault(buffer, (unsigned char *)ctxt->regs->ip, MAX_INSN_SIZE)) return 0; return MAX_INSN_SIZE; }static enum
es_resultvc_decode_insn(struct es_em_ctxt *ctxt)
Quoted 13 lines
{
char buffer[MAX_INSN_SIZE];
int nbytes;
if (user_mode(ctxt->regs))
nbytes = insn_fetch_from_user(ctxt->regs, buffer);
else
nbytes = vc_fetch_insn_kernel(ctxt, buffer);
if (!nbytes) {
ctxt->fi.vector = X86_TRAP_PF;
ctxt->fi.error_code = X86_PF_INSTR;
if (user_mode(ctxt->regs))... this second repeated check here is not what I would call that.
But this is my personal preference only so it's up for a vote now.
:-)
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquetteRe: [PATCH v1 11/19] x86/sev-es: Convert to insn_decode()
Quoted 6 lines · Borislav Petkov
Quoted 3 lines · Sean Christopherson
Alternatively, could the kernel case use
insn_decode_regs()? Ifvc_fetch_insn_kernel()were also modified to mirrorinsn_fetch_from_user(), the two code paths could be unified except for the the fetch and the PFEC. E.g.Personal Firearms Eligibility Check?
Ha, Page Fault Error Code.
Quoted 23 lines
In any case, I prefer simple, easy to follow code at a quick glance. Stuff like...
Quoted 20 lines
static int vc_fetch_insn_kernel(struct
es_em_ctxt*ctxt,
unsigned char *buffer){ if (copy_from_kernel_nofault(buffer, (unsigned char *)ctxt->regs->ip, MAX_INSN_SIZE)) return 0; return MAX_INSN_SIZE; }static enum
es_resultvc_decode_insn(struct es_em_ctxt *ctxt){ char buffer[MAX_INSN_SIZE]; int nbytes; if (user_mode(ctxt->regs)) nbytes = insn_fetch_from_user(ctxt->regs, buffer); else nbytes = vc_fetch_insn_kernel(ctxt, buffer);
Quoted 6 lines
Quoted 4 lines
if (!nbytes) { ctxt->fi.vector = X86_TRAP_PF; ctxt->fi.error_code = X86_PF_INSTR; if (user_mode(ctxt->regs))... this second repeated check here is not what I would call that.
But then you're stuck maintaining two separate flows that do the same thing.
Quoted 1 line
But this is my personal preference only so it's up for a vote now.
Rock Paper Scissors?
Borislav Petkov
maintainerQuoted 15 lines · Tom Lendacky
Quoted 3 lines
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.
That's the way it works today, right? One instruction, no matter the length of the buffer (assuming the length is long enough to include a full instruction)?
Because the callers of the decode may rely on parsing only the current instruction (like SEV-ES), it should probably default to that (although most of the call points are being updated so you could supply a boolean to indicate one vs many instructions). The caller doesn't necessarily know the length of the instruction, so it may provide a buffer of max instruction length.
Quoted 4 lines
Also, if you want to parse more than one instruction at a time, wouldn't you need to maintain register context within the parsing, I don't think that is done today. Or you could chain together some instruction contexts to identify each instruction that was parsed?
Yah, let's leave it all to the one who actually needs multiple insn parsing.
Signature · 4 lines
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquette