Skip to contentSkip to conversation

i2c: core-smbus: don't trace smbus_reply data on errors

PATCH Superseded John Sperbeck 3 participants 8 messages Jan 4, 2019 – Feb 11, 2019

Subsystems (3)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 i2c: core-smbus: don't trace smbus_reply data on errors

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid copying from the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

---
 drivers/i2c/i2c-core-smbus.c |  2 +-
 include/trace/events/smbus.h | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
drivers/i2c/i2c-core-smbus.c +1 -1
index 9cd66cabb84f..132119112596 100644
@@ -585,7 +585,7 @@ s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 trace:
 	/* If enabled, the reply tracepoint is conditional on read_write. */
 	trace_smbus_reply(adapter, addr, flags, read_write,
-			  command, protocol, data);
+			  command, protocol, data, res);
 	trace_smbus_result(adapter, addr, flags, read_write,
 			   command, protocol, res);
 
include/trace/events/smbus.h +5 -5
index d2fb6e1d3e10..b6376a7c7e74 100644
@@ -138,8 +138,8 @@ TRACE_EVENT_CONDITION(smbus_reply,
 	TP_PROTO(const struct i2c_adapter *adap,
 		 u16 addr, unsigned short flags,
 		 char read_write, u8 command, int protocol,
-		 const union i2c_smbus_data *data),
-	TP_ARGS(adap, addr, flags, read_write, command, protocol, data),
+		 const union i2c_smbus_data *data, int res),
+	TP_ARGS(adap, addr, flags, read_write, command, protocol, data, res),
 	TP_CONDITION(read_write == I2C_SMBUS_READ),
 	TP_STRUCT__entry(
 		__field(int,	adapter_nr		)
@@ -159,16 +159,16 @@ TRACE_EVENT_CONDITION(smbus_reply,
 		switch (protocol) {
 		case I2C_SMBUS_BYTE:
 		case I2C_SMBUS_BYTE_DATA:
-			__entry->len = 1;
+			__entry->len = res < 0 ? 0 : 1;
 			goto copy;
 		case I2C_SMBUS_WORD_DATA:
 		case I2C_SMBUS_PROC_CALL:
-			__entry->len = 2;
+			__entry->len = res < 0 ? 0 : 2;
 			goto copy;
 		case I2C_SMBUS_BLOCK_DATA:
 		case I2C_SMBUS_BLOCK_PROC_CALL:
 		case I2C_SMBUS_I2C_BLOCK_DATA:
-			__entry->len = data->block[0] + 1;
+			__entry->len = res < 0 ? 0 : data->block[0] + 1;
 		copy:
 			memcpy(__entry->buf, data->block, __entry->len);
 			break;
Signature · 1 line
2.20.1.415.g653613c723-goog
maintainer
#1 lore raw
Quoted 30 lines · On Thu, 3 Jan 2019 16:42:03 -0800 John Sperbeck <[email protected]> wrote:

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid copying from the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

---
 drivers/i2c/i2c-core-smbus.c |  2 +-
 include/trace/events/smbus.h | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
drivers/i2c/i2c-core-smbus.c +1 -1
index 9cd66cabb84f..132119112596 100644
@@ -585,7 +585,7 @@ s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 trace:
 	/* If enabled, the reply tracepoint is conditional on read_write. */
 	trace_smbus_reply(adapter, addr, flags, read_write,
-			  command, protocol, data);
+			  command, protocol, data, res);
 	trace_smbus_result(adapter, addr, flags, read_write,
 			   command, protocol, res);
 
include/trace/events/smbus.h +0 -0
index d2fb6e1d3e10..b6376a7c7e74 100644

include/trace/events/smbus.h TRACE_EVENT_CONDITION(smbus_reply, · line 143

Quoted 8 lines
include/trace/events/smbus.h +2 -2
@@ -138,8 +138,8 @@ TRACE_EVENT_CONDITION(smbus_reply,
 	TP_PROTO(const struct i2c_adapter *adap,
 		 u16 addr, unsigned short flags,
 		 char read_write, u8 command, int protocol,
-		 const union i2c_smbus_data *data),
-	TP_ARGS(adap, addr, flags, read_write, command, protocol, data),
+		 const union i2c_smbus_data *data, int res),
+	TP_ARGS(adap, addr, flags, read_write, command, protocol, data, res),
 	TP_CONDITION(read_write == I2C_SMBUS_READ),

Hmm, instead of tracing nothing, as this is already a "conditional trace event", why not add to that condition:

	TP_CONDITION(res >= 0 && read_write == I2C_SMBUS_READ),

Unless you want to still trace some data on failure.

-- Steve

Quoted 22 lines
include/trace/events/smbus.h +3 -3
 	TP_STRUCT__entry(
 		__field(int,	adapter_nr		)
@@ -159,16 +159,16 @@ TRACE_EVENT_CONDITION(smbus_reply,
 		switch (protocol) {
 		case I2C_SMBUS_BYTE:
 		case I2C_SMBUS_BYTE_DATA:
-			__entry->len = 1;
+			__entry->len = res < 0 ? 0 : 1;
 			goto copy;
 		case I2C_SMBUS_WORD_DATA:
 		case I2C_SMBUS_PROC_CALL:
-			__entry->len = 2;
+			__entry->len = res < 0 ? 0 : 2;
 			goto copy;
 		case I2C_SMBUS_BLOCK_DATA:
 		case I2C_SMBUS_BLOCK_PROC_CALL:
 		case I2C_SMBUS_I2C_BLOCK_DATA:
-			__entry->len = data->block[0] + 1;
+			__entry->len = res < 0 ? 0 : data->block[0] + 1;
 		copy:
 			memcpy(__entry->buf, data->block, __entry->len);
 			break;
#2 lore raw
Quoted 45 lines · Steven Rostedt
Quoted 30 lines · On Thu, 3 Jan 2019 16:42:03 -0800 John Sperbeck <[email protected]> wrote:

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid copying from the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

---
 drivers/i2c/i2c-core-smbus.c |  2 +-
 include/trace/events/smbus.h | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
drivers/i2c/i2c-core-smbus.c +1 -1
index 9cd66cabb84f..132119112596 100644
@@ -585,7 +585,7 @@ s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 trace:
 	/* If enabled, the reply tracepoint is conditional on read_write. */
 	trace_smbus_reply(adapter, addr, flags, read_write,
-			  command, protocol, data);
+			  command, protocol, data, res);
 	trace_smbus_result(adapter, addr, flags, read_write,
 			   command, protocol, res);
 
include/trace/events/smbus.h +0 -0
index d2fb6e1d3e10..b6376a7c7e74 100644

include/trace/events/smbus.h TRACE_EVENT_CONDITION(smbus_reply, · line 143

Quoted 8 lines
include/trace/events/smbus.h +2 -2
@@ -138,8 +138,8 @@ TRACE_EVENT_CONDITION(smbus_reply,
 	TP_PROTO(const struct i2c_adapter *adap,
 		 u16 addr, unsigned short flags,
 		 char read_write, u8 command, int protocol,
-		 const union i2c_smbus_data *data),
-	TP_ARGS(adap, addr, flags, read_write, command, protocol, data),
+		 const union i2c_smbus_data *data, int res),
+	TP_ARGS(adap, addr, flags, read_write, command, protocol, data, res),
 	TP_CONDITION(read_write == I2C_SMBUS_READ),

Hmm, instead of tracing nothing, as this is already a "conditional trace event", why not add to that condition:

Quoted 3 lines
	TP_CONDITION(res >= 0 && read_write == I2C_SMBUS_READ),

Unless you want to still trace some data on failure.

John, any comment to this?

#3 lore raw
Quoted 47 lines · Wolfram Sang
Quoted 45 lines · Steven Rostedt
Quoted 30 lines · On Thu, 3 Jan 2019 16:42:03 -0800 John Sperbeck <[email protected]> wrote:

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid copying from the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

---
 drivers/i2c/i2c-core-smbus.c |  2 +-
 include/trace/events/smbus.h | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)
drivers/i2c/i2c-core-smbus.c +1 -1
index 9cd66cabb84f..132119112596 100644
@@ -585,7 +585,7 @@ s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 trace:
    /* If enabled, the reply tracepoint is conditional on read_write. */
    trace_smbus_reply(adapter, addr, flags, read_write,
-                     command, protocol, data);
+                     command, protocol, data, res);
    trace_smbus_result(adapter, addr, flags, read_write,
                       command, protocol, res);
 
include/trace/events/smbus.h +0 -0
index d2fb6e1d3e10..b6376a7c7e74 100644

include/trace/events/smbus.h TRACE_EVENT_CONDITION(smbus_reply, · line 143

Quoted 8 lines
include/trace/events/smbus.h +2 -2
@@ -138,8 +138,8 @@ TRACE_EVENT_CONDITION(smbus_reply,
    TP_PROTO(const struct i2c_adapter *adap,
             u16 addr, unsigned short flags,
             char read_write, u8 command, int protocol,
-            const union i2c_smbus_data *data),
-   TP_ARGS(adap, addr, flags, read_write, command, protocol, data),
+            const union i2c_smbus_data *data, int res),
+   TP_ARGS(adap, addr, flags, read_write, command, protocol, data, res),
    TP_CONDITION(read_write == I2C_SMBUS_READ),

Hmm, instead of tracing nothing, as this is already a "conditional trace event", why not add to that condition:

Quoted 6 lines
Quoted 3 lines
      TP_CONDITION(res >= 0 && read_write == I2C_SMBUS_READ),

Unless you want to still trace some data on failure.

John, any comment to this?

The issue we were dealing with was access to uninitialized memory on the stack. The change '30f939feaeee i2c: fix kernel memory disclosure in dev interface' does the initialization, so the tracing code is no longer affected. We just didn't
have that change in the particular kernel we were testing.

Still, Steven's suggestion seems fine to me. Would you like me to create a new patch based on that?

#4 lore raw
Quoted 11 lines
Quoted 10 lines
Quoted 7 lines

Hmm, instead of tracing nothing, as this is already a "conditional trace event", why not add to that condition:

      TP_CONDITION(res >= 0 && read_write == I2C_SMBUS_READ),

Unless you want to still trace some data on failure.

John, any comment to this?

Quoted 8 lines

The issue we were dealing with was access to uninitialized memory on the stack. The change '30f939feaeee i2c: fix kernel memory disclosure in dev interface' does the initialization, so the tracing code is no longer affected. We just didn't
have that change in the particular kernel we were testing.

Still, Steven's suggestion seems fine to me. Would you like me to create a new patch based on that?

I am not a tracing expert, but all that was said here tell me that it would be better to have the change. So, yes, please, that would be appreciated.

#5 lore raw

PATCH v2 1/1 i2c: core-smbus: don't trace smbus_reply data on errors

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid trying to show the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

---
 drivers/i2c/i2c-core-smbus.c | 2 +-
 include/trace/events/smbus.h | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)
drivers/i2c/i2c-core-smbus.c +1 -1
index 9cd66cabb84f..132119112596 100644
@@ -585,7 +585,7 @@ s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 trace:
 	/* If enabled, the reply tracepoint is conditional on read_write. */
 	trace_smbus_reply(adapter, addr, flags, read_write,
-			  command, protocol, data);
+			  command, protocol, data, res);
 	trace_smbus_result(adapter, addr, flags, read_write,
 			   command, protocol, res);
 
include/trace/events/smbus.h +3 -3
index d2fb6e1d3e10..a4892a187842 100644
@@ -138,9 +138,9 @@ TRACE_EVENT_CONDITION(smbus_reply,
 	TP_PROTO(const struct i2c_adapter *adap,
 		 u16 addr, unsigned short flags,
 		 char read_write, u8 command, int protocol,
-		 const union i2c_smbus_data *data),
-	TP_ARGS(adap, addr, flags, read_write, command, protocol, data),
-	TP_CONDITION(read_write == I2C_SMBUS_READ),
+		 const union i2c_smbus_data *data, int res),
+	TP_ARGS(adap, addr, flags, read_write, command, protocol, data, res),
+	TP_CONDITION(res >= 0 && read_write == I2C_SMBUS_READ),
 	TP_STRUCT__entry(
 		__field(int,	adapter_nr		)
 		__field(__u16,	addr			)
Signature · 1 line
2.20.1.791.gb4d0f1c61a-goog
maintainer
#6 lore raw
Quoted 5 lines · On Sun, 10 Feb 2019 19:40:21 -0800 John Sperbeck <[email protected]> wrote:

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid trying to show the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

This looks fine to me, but I'm not sure how the i2c maintainers feel, but I always require that a new patch version starts a new thread, and not be part of a older thread release (causes these patches to be hidden from those that read patches in threading mode).

-- Steve

Quoted 37 lines
---
 drivers/i2c/i2c-core-smbus.c | 2 +-
 include/trace/events/smbus.h | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)
drivers/i2c/i2c-core-smbus.c +1 -1
index 9cd66cabb84f..132119112596 100644
@@ -585,7 +585,7 @@ s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 trace:
 	/* If enabled, the reply tracepoint is conditional on read_write. */
 	trace_smbus_reply(adapter, addr, flags, read_write,
-			  command, protocol, data);
+			  command, protocol, data, res);
 	trace_smbus_result(adapter, addr, flags, read_write,
 			   command, protocol, res);
 
include/trace/events/smbus.h +3 -3
index d2fb6e1d3e10..a4892a187842 100644
@@ -138,9 +138,9 @@ TRACE_EVENT_CONDITION(smbus_reply,
 	TP_PROTO(const struct i2c_adapter *adap,
 		 u16 addr, unsigned short flags,
 		 char read_write, u8 command, int protocol,
-		 const union i2c_smbus_data *data),
-	TP_ARGS(adap, addr, flags, read_write, command, protocol, data),
-	TP_CONDITION(read_write == I2C_SMBUS_READ),
+		 const union i2c_smbus_data *data, int res),
+	TP_ARGS(adap, addr, flags, read_write, command, protocol, data, res),
+	TP_CONDITION(res >= 0 && read_write == I2C_SMBUS_READ),
 	TP_STRUCT__entry(
 		__field(int,	adapter_nr		)
 		__field(__u16,	addr			)
#7 lore raw
Quoted 10 lines · Steven Rostedt
Quoted 5 lines · On Sun, 10 Feb 2019 19:40:21 -0800 John Sperbeck <[email protected]> wrote:

If an smbus transfer fails, there's no guarantee that the output buffer was written. So, avoid trying to show the output buffer when tracing after an error. This was 'mostly harmless', but would trip up kasan checking if left-over cruft in byte 0 is a large length, causing us to read from unwritten memory.

Quoted 4 lines

This looks fine to me, but I'm not sure how the i2c maintainers feel, but I always require that a new patch version starts a new thread, and not be part of a older thread release (causes these patches to be hidden from those that read patches in threading mode).

That sounds reasonable to me. Unless I hear otherwise, I'll create a v3 as a new thread. Thanks.