Skip to contentSkip to conversation

drivers/edac/edac_mc: Remove all strcpy() uses

PATCH Superseded Len Baker 2 participants 3 messages Jul 25, 2021 – Jul 31, 2021 EDAC-core

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Len Baker

author
#0 lore raw

PATCH 1/1 drivers/edac/edac_mc: Remove all strcpy() uses

strcpy() performs no bounds checking on the destination buffer. This could result in linear overflows beyond the end of the buffer, leading to all kinds of misbehaviors. The safe replacement is strscpy().

However, to add labels is better to use the scnprintf to simplify the arithmetic.

This is a previous step in the path to remove the strcpy() function entirely from the kernel.

---
This is a task of the KSPP [1]

[1] https://github.com/KSPP/linux/issues/88

 drivers/edac/edac_mc.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
drivers/edac/edac_mc.c +8 -8
index f6d462d0be2d..1286364f0e48 100644
@@ -1027,6 +1027,7 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 {
 	struct dimm_info *dimm;
 	char *p;
+	size_t p_size = 0;
 	int row = -1, chan = -1;
 	int pos[EDAC_MAX_LAYERS] = { top_layer, mid_layer, low_layer };
 	int i, n_labels = 0;
@@ -1113,12 +1114,11 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 			p = e->label;
 			*p = '\0';
 		} else {
-			if (p != e->label) {
-				strcpy(p, OTHER_LABEL);
-				p += strlen(OTHER_LABEL);
-			}
-			strcpy(p, dimm->label);
-			p += strlen(p);
+			const char *or = (p != e->label) ? OTHER_LABEL : "";
+
+			p_size += scnprintf(p + p_size,
+					    sizeof(e->label) - p_size,
+					    "%s%s", or, dimm->label);
 		}
 
 		/*
@@ -1140,9 +1140,9 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 	}
 
 	if (any_memory)
-		strcpy(e->label, "any memory");
+		strscpy(e->label, "any memory", sizeof(e->label));
 	else if (!*e->label)
-		strcpy(e->label, "unknown memory");
+		strscpy(e->label, "unknown memory", sizeof(e->label));
 
 	edac_inc_csrow(e, row, chan);
 

--
2.25.1

#1 lore raw
Quoted 24 lines · Len Baker

strcpy() performs no bounds checking on the destination buffer. This could result in linear overflows beyond the end of the buffer, leading to all kinds of misbehaviors. The safe replacement is strscpy().

However, to add labels is better to use the scnprintf to simplify the arithmetic.

This is a previous step in the path to remove the strcpy() function entirely from the kernel.

---
This is a task of the KSPP [1]

[1] https://github.com/KSPP/linux/issues/88

 drivers/edac/edac_mc.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
drivers/edac/edac_mc.c +0 -0
index f6d462d0be2d..1286364f0e48 100644

drivers/edac/edac_mc.c void edac_mc_handle_error(const enum hw_event_mc_err_type type, · line 1030

Quoted 4 lines
drivers/edac/edac_mc.c +1 -0
@@ -1027,6 +1027,7 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 {
 	struct dimm_info *dimm;
 	char *p;
+	size_t p_size = 0;

I would rather use a 'left' variable which is initialized with sizeof(e->label) close to there p = e->label is.

Quoted 8 lines
drivers/edac/edac_mc.c +0 -1
 	int row = -1, chan = -1;
 	int pos[EDAC_MAX_LAYERS] = { top_layer, mid_layer, low_layer };
 	int i, n_labels = 0;
@@ -1113,12 +1114,11 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 			p = e->label;
 			*p = '\0';
 		} else {
-			if (p != e->label) {

drivers/edac/edac_mc.c void edac_mc_handle_error(const enum hw_event_mc_err_type type, · line 1121

Quoted 10 lines
drivers/edac/edac_mc.c +5 -5
-				strcpy(p, OTHER_LABEL);
-				p += strlen(OTHER_LABEL);
-			}
-			strcpy(p, dimm->label);
-			p += strlen(p);
+			const char *or = (p != e->label) ? OTHER_LABEL : "";
+
+			p_size += scnprintf(p + p_size,
+					    sizeof(e->label) - p_size,
+					    "%s%s", or, dimm->label);

My preference is to advance p here (and decrement 'left'). This is the pattern how p is used throughout the code. I also don't see a benefit of using scnprintf() here compared to the previous implementation.

Thanks,

-Robert

Quoted 18 lines
drivers/edac/edac_mc.c +2 -3
 		}
 
 		/*
@@ -1140,9 +1140,9 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 	}
 
 	if (any_memory)
-		strcpy(e->label, "any memory");
+		strscpy(e->label, "any memory", sizeof(e->label));
 	else if (!*e->label)
-		strcpy(e->label, "unknown memory");
+		strscpy(e->label, "unknown memory", sizeof(e->label));
 
 	edac_inc_csrow(e, row, chan);
 
--

2.25.1

author
#2 lore raw

Hi,

Quoted 4 lines · Robert Richter
Quoted 3 lines · Len Baker
 drivers/edac/edac_mc.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
Quoted 12 lines

drivers/edac/edac_mc.c void edac_mc_handle_error(const enum hw_event_mc_err_type type, · line 1030

Quoted 9 lines
drivers/edac/edac_mc.c +1 -0
index f6d462d0be2d..1286364f0e48 100644
@@ -1027,6 +1027,7 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 {
 	struct dimm_info *dimm;
 	char *p;
+	size_t p_size = 0;

I would rather use a 'left' variable which is initialized with sizeof(e->label) close to there p = e->label is.

Ok.

Quoted 14 lines
Quoted 14 lines
drivers/edac/edac_mc.c +1 -6
 	int row = -1, chan = -1;
 	int pos[EDAC_MAX_LAYERS] = { top_layer, mid_layer, low_layer };
 	int i, n_labels = 0;
@@ -1113,12 +1114,11 @@ void edac_mc_handle_error(const enum hw_event_mc_err_type type,
 			p = e->label;
 			*p = '\0';
 		} else {
-			if (p != e->label) {
-				strcpy(p, OTHER_LABEL);
-				p += strlen(OTHER_LABEL);
-			}
-			strcpy(p, dimm->label);
-			p += strlen(p);
+			const char *or = (p != e->label) ? OTHER_LABEL : "";
Quoted 8 lines

drivers/edac/edac_mc.c void edac_mc_handle_error(const enum hw_event_mc_err_type type, · line 1121

Quoted 4 lines
drivers/edac/edac_mc.c +4 -0
+
+			p_size += scnprintf(p + p_size,
+					    sizeof(e->label) - p_size,
+					    "%s%s", or, dimm->label);

My preference is to advance p here (and decrement 'left'). This is the pattern how p is used throughout the code. I also don't see a benefit of using scnprintf() here compared to the previous implementation.

Ok, no problem. I will send a new version more close to the original. The scnprintf() returns the number of bytes writes to the buffer, so it is not necessary to use the strlen() function. But if you prefer the current pattern I will have no objection.

Regards,
Len