linux/include/trace/events/spmi.h
David Collins 2af28b241e spmi: trace: fix stack-out-of-bound access in SPMI tracing functions
trace_spmi_write_begin() and trace_spmi_read_end() both call
memcpy() with a length of "len + 1".  This leads to one extra
byte being read beyond the end of the specified buffer.  Fix
this out-of-bound memory access by using a length of "len"
instead.

Here is a KASAN log showing the issue:

BUG: KASAN: stack-out-of-bounds in trace_event_raw_event_spmi_read_end+0x1d0/0x234
Read of size 2 at addr ffffffc0265b7540 by task thermal@2.0-ser/1314
...
Call trace:
 dump_backtrace+0x0/0x3e8
 show_stack+0x2c/0x3c
 dump_stack_lvl+0xdc/0x11c
 print_address_description+0x74/0x384
 kasan_report+0x188/0x268
 kasan_check_range+0x270/0x2b0
 memcpy+0x90/0xe8
 trace_event_raw_event_spmi_read_end+0x1d0/0x234
 spmi_read_cmd+0x294/0x3ac
 spmi_ext_register_readl+0x84/0x9c
 regmap_spmi_ext_read+0x144/0x1b0 [regmap_spmi]
 _regmap_raw_read+0x40c/0x754
 regmap_raw_read+0x3a0/0x514
 regmap_bulk_read+0x418/0x494
 adc5_gen3_poll_wait_hs+0xe8/0x1e0 [qcom_spmi_adc5_gen3]
 ...
 __arm64_sys_read+0x4c/0x60
 invoke_syscall+0x80/0x218
 el0_svc_common+0xec/0x1c8
 ...

addr ffffffc0265b7540 is located in stack of task thermal@2.0-ser/1314 at offset 32 in frame:
 adc5_gen3_poll_wait_hs+0x0/0x1e0 [qcom_spmi_adc5_gen3]

this frame has 1 object:
 [32, 33) 'status'

Memory state around the buggy address:
 ffffffc0265b7400: 00 00 00 00 00 00 00 00 00 00 00 00 f1 f1 f1 f1
 ffffffc0265b7480: 04 f3 f3 f3 00 00 00 00 00 00 00 00 00 00 00 00
>ffffffc0265b7500: 00 00 00 00 f1 f1 f1 f1 01 f3 f3 f3 00 00 00 00
                                           ^
 ffffffc0265b7580: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 ffffffc0265b7600: f1 f1 f1 f1 01 f2 07 f2 f2 f2 01 f3 00 00 00 00
==================================================================

Fixes: a9fce37481 ("spmi: add command tracepoints for SPMI")
Cc: stable@vger.kernel.org
Reviewed-by: Stephen Boyd <sboyd@kernel.org>
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: David Collins <quic_collinsd@quicinc.com>
Link: https://lore.kernel.org/r/20220627235512.2272783-1-quic_collinsd@quicinc.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2022-07-24 16:16:44 +02:00

137 lines
3.2 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
#undef TRACE_SYSTEM
#define TRACE_SYSTEM spmi
#if !defined(_TRACE_SPMI_H) || defined(TRACE_HEADER_MULTI_READ)
#define _TRACE_SPMI_H
#include <linux/spmi.h>
#include <linux/tracepoint.h>
/*
* drivers/spmi/spmi.c
*/
TRACE_EVENT(spmi_write_begin,
TP_PROTO(u8 opcode, u8 sid, u16 addr, u8 len, const u8 *buf),
TP_ARGS(opcode, sid, addr, len, buf),
TP_STRUCT__entry(
__field ( u8, opcode )
__field ( u8, sid )
__field ( u16, addr )
__field ( u8, len )
__dynamic_array ( u8, buf, len )
),
TP_fast_assign(
__entry->opcode = opcode;
__entry->sid = sid;
__entry->addr = addr;
__entry->len = len;
memcpy(__get_dynamic_array(buf), buf, len);
),
TP_printk("opc=%d sid=%02d addr=0x%04x len=%d buf=0x[%*phD]",
(int)__entry->opcode, (int)__entry->sid,
(int)__entry->addr, (int)__entry->len,
(int)__entry->len, __get_dynamic_array(buf))
);
TRACE_EVENT(spmi_write_end,
TP_PROTO(u8 opcode, u8 sid, u16 addr, int ret),
TP_ARGS(opcode, sid, addr, ret),
TP_STRUCT__entry(
__field ( u8, opcode )
__field ( u8, sid )
__field ( u16, addr )
__field ( int, ret )
),
TP_fast_assign(
__entry->opcode = opcode;
__entry->sid = sid;
__entry->addr = addr;
__entry->ret = ret;
),
TP_printk("opc=%d sid=%02d addr=0x%04x ret=%d",
(int)__entry->opcode, (int)__entry->sid,
(int)__entry->addr, __entry->ret)
);
TRACE_EVENT(spmi_read_begin,
TP_PROTO(u8 opcode, u8 sid, u16 addr),
TP_ARGS(opcode, sid, addr),
TP_STRUCT__entry(
__field ( u8, opcode )
__field ( u8, sid )
__field ( u16, addr )
),
TP_fast_assign(
__entry->opcode = opcode;
__entry->sid = sid;
__entry->addr = addr;
),
TP_printk("opc=%d sid=%02d addr=0x%04x",
(int)__entry->opcode, (int)__entry->sid,
(int)__entry->addr)
);
TRACE_EVENT(spmi_read_end,
TP_PROTO(u8 opcode, u8 sid, u16 addr, int ret, u8 len, const u8 *buf),
TP_ARGS(opcode, sid, addr, ret, len, buf),
TP_STRUCT__entry(
__field ( u8, opcode )
__field ( u8, sid )
__field ( u16, addr )
__field ( int, ret )
__field ( u8, len )
__dynamic_array ( u8, buf, len )
),
TP_fast_assign(
__entry->opcode = opcode;
__entry->sid = sid;
__entry->addr = addr;
__entry->ret = ret;
__entry->len = len;
memcpy(__get_dynamic_array(buf), buf, len);
),
TP_printk("opc=%d sid=%02d addr=0x%04x ret=%d len=%02d buf=0x[%*phD]",
(int)__entry->opcode, (int)__entry->sid,
(int)__entry->addr, __entry->ret, (int)__entry->len,
(int)__entry->len, __get_dynamic_array(buf))
);
TRACE_EVENT(spmi_cmd,
TP_PROTO(u8 opcode, u8 sid, int ret),
TP_ARGS(opcode, sid, ret),
TP_STRUCT__entry(
__field ( u8, opcode )
__field ( u8, sid )
__field ( int, ret )
),
TP_fast_assign(
__entry->opcode = opcode;
__entry->sid = sid;
__entry->ret = ret;
),
TP_printk("opc=%d sid=%02d ret=%d", (int)__entry->opcode,
(int)__entry->sid, ret)
);
#endif /* _TRACE_SPMI_H */
/* This part must be outside protection */
#include <trace/define_trace.h>