Skip to contentSkip to conversation

usbip: tools: fix GCC8 warning for strncpy

PATCH In review Liu, Changcheng 2 participants 4 messages Jul 25, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 usbip: tools: fix GCC8 warning for strncpy

GCC8 started emitting warning about using strncpy with number of bytes exactly equal destination size which could lead to non-zero terminated string being copied. Use "SYSFS_PATH_MAX - 1" & "SYSFS_BUS_ID_SIZE - 1" as number of bytes to ensure name is always zero-terminated.

---
v1 -> v2:
* Correct array tail index

---
 tools/usb/usbip/libsrc/usbip_common.c        | 6 ++++--
 tools/usb/usbip/libsrc/usbip_device_driver.c | 6 ++++--
 2 files changed, 8 insertions(+), 4 deletions(-)
tools/usb/usbip/libsrc/usbip_common.c +4 -2
index bb424638d75b..b8d7d480595a 100644
@@ -226,8 +226,10 @@ int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev)
 	path = udev_device_get_syspath(sdev);
 	name = udev_device_get_sysname(sdev);
 
-	strncpy(udev->path,  path,  SYSFS_PATH_MAX);
-	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(udev->path,  path,  SYSFS_PATH_MAX - 1);
+	udev->path[SYSFS_PATH_MAX - 1] = '\0';
+	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	udev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';
 
 	sscanf(name, "%u-%u", &busnum, &devnum);
 	udev->busnum = busnum;
tools/usb/usbip/libsrc/usbip_device_driver.c +4 -2
index 5a3726eb44ab..051d7d3f443b 100644
@@ -91,7 +91,8 @@ int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)
 	copy_descr_attr16(dev, &descr, idProduct);
 	copy_descr_attr16(dev, &descr, bcdDevice);
 
-	strncpy(dev->path, path, SYSFS_PATH_MAX);
+	strncpy(dev->path, path, SYSFS_PATH_MAX - 1);
+	dev->path[SYSFS_PATH_MAX - 1] = '\0';
 
 	dev->speed = USB_SPEED_UNKNOWN;
 	speed = udev_device_get_sysattr_value(sdev, "current_speed");
@@ -110,7 +111,8 @@ int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)
 	dev->busnum = 0;
 
 	name = udev_device_get_sysname(plat);
-	strncpy(dev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(dev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	dev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';
 	return 0;
 err:
 	fclose(fd);
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 19 lines · Changcheng

GCC8 started emitting warning about using strncpy with number of bytes exactly equal destination size which could lead to non-zero terminated string being copied. Use "SYSFS_PATH_MAX - 1" & "SYSFS_BUS_ID_SIZE - 1" as number of bytes to ensure name is always zero-terminated.

---
v1 -> v2:
* Correct array tail index

---
  tools/usb/usbip/libsrc/usbip_common.c        | 6 ++++--
  tools/usb/usbip/libsrc/usbip_device_driver.c | 6 ++++--
  2 files changed, 8 insertions(+), 4 deletions(-)
tools/usb/usbip/libsrc/usbip_common.c +0 -0
index bb424638d75b..b8d7d480595a 100644

tools/usb/usbip/libsrc/usbip_common.c int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev) · line 232

Quoted 9 lines
tools/usb/usbip/libsrc/usbip_common.c +4 -2
@@ -226,8 +226,10 @@ int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev)
  	path = udev_device_get_syspath(sdev);
  	name = udev_device_get_sysname(sdev);
 
-	strncpy(udev->path,  path,  SYSFS_PATH_MAX);
-	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(udev->path,  path,  SYSFS_PATH_MAX - 1);
+	udev->path[SYSFS_PATH_MAX - 1] = '\0';
+	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	udev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';

strlcpy() would be better choice here. Any reason to not use that?

Quoted 18 lines
tools/usb/usbip/libsrc/usbip_common.c +0 -0
  	sscanf(name, "%u-%u", &busnum, &devnum);
  	udev->busnum = busnum;
tools/usb/usbip/libsrc/usbip_device_driver.c +2 -1
index 5a3726eb44ab..051d7d3f443b 100644
@@ -91,7 +91,8 @@ int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)
  	copy_descr_attr16(dev, &descr, idProduct);
  	copy_descr_attr16(dev, &descr, bcdDevice);
 
-	strncpy(dev->path, path, SYSFS_PATH_MAX);
+	strncpy(dev->path, path, SYSFS_PATH_MAX - 1);
+	dev->path[SYSFS_PATH_MAX - 1] = '\0';
 
  	dev->speed = USB_SPEED_UNKNOWN;
  	speed = udev_device_get_sysattr_value(sdev, "current_speed");

tools/usb/usbip/libsrc/usbip_device_driver.c int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev) · line 115

Quoted 6 lines
tools/usb/usbip/libsrc/usbip_device_driver.c +2 -1
@@ -110,7 +111,8 @@ int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)
  	dev->busnum = 0;
 
  	name = udev_device_get_sysname(plat);
-	strncpy(dev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(dev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	dev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';

strlcpy() would be better choice here. Any reason to not use that?

tools/usb/usbip/libsrc/usbip_device_driver.c int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev) · line 118

Quoted 4 lines
tools/usb/usbip/libsrc/usbip_device_driver.c +0 -0
  	return 0;
  err:
  	fclose(fd);

thanks,
-- Shuah

#2 lore raw
Quoted 15 lines · shuah
Quoted 14 lines · Changcheng

GCC8 started emitting warning about using strncpy with number of bytes exactly equal destination size which could lead to non-zero terminated string being copied. Use "SYSFS_PATH_MAX - 1" & "SYSFS_BUS_ID_SIZE - 1" as number of bytes to ensure name is always zero-terminated.

---
v1 -> v2:
* Correct array tail index

---
  tools/usb/usbip/libsrc/usbip_common.c        | 6 ++++--
  tools/usb/usbip/libsrc/usbip_device_driver.c | 6 ++++--
  2 files changed, 8 insertions(+), 4 deletions(-)
Quoted 16 lines

tools/usb/usbip/libsrc/usbip_common.c int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev) · line 231

Quoted 13 lines
tools/usb/usbip/libsrc/usbip_common.c +4 -2
index bb424638d75b..b8d7d480595a 100644
@@ -226,8 +226,10 @@ int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev)
  	path = udev_device_get_syspath(sdev);
  	name = udev_device_get_sysname(sdev);
-	strncpy(udev->path,  path,  SYSFS_PATH_MAX);
-	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(udev->path,  path,  SYSFS_PATH_MAX - 1);
+	udev->path[SYSFS_PATH_MAX - 1] = '\0';
+	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	udev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';

strlcpy() would be better choice here. Any reason to not use that?

@Shuah: linux tools link with libc which doesn't implment strlcpy yet. So tools source code can't use strlcpy function like other kernel source code.

Quoted 30 lines
Quoted 15 lines
tools/usb/usbip/libsrc/usbip_common.c +0 -0
  	sscanf(name, "%u-%u", &busnum, &devnum);
  	udev->busnum = busnum;
tools/usb/usbip/libsrc/usbip_device_driver.c +2 -1
index 5a3726eb44ab..051d7d3f443b 100644
@@ -91,7 +91,8 @@ int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)
  	copy_descr_attr16(dev, &descr, idProduct);
  	copy_descr_attr16(dev, &descr, bcdDevice);
-	strncpy(dev->path, path, SYSFS_PATH_MAX);
+	strncpy(dev->path, path, SYSFS_PATH_MAX - 1);
+	dev->path[SYSFS_PATH_MAX - 1] = '\0';
  	dev->speed = USB_SPEED_UNKNOWN;
  	speed = udev_device_get_sysattr_value(sdev, "current_speed");

tools/usb/usbip/libsrc/usbip_device_driver.c int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev) · line 114

Quoted 5 lines
tools/usb/usbip/libsrc/usbip_device_driver.c +2 -1
@@ -110,7 +111,8 @@ int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)
  	dev->busnum = 0;
  	name = udev_device_get_sysname(plat);
-	strncpy(dev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(dev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	dev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';

strlcpy() would be better choice here. Any reason to not use that?

tools/usb/usbip/libsrc/usbip_device_driver.c int read_usb_vudc_device(struct udev_device *sdev, struct usbip_usb_device *dev)

Quoted 4 lines
tools/usb/usbip/libsrc/usbip_device_driver.c +0 -0
  	return 0;
  err:
  	fclose(fd);
 

thanks,
-- Shuah

maintainer Acked-by Shuah Khan
#3 lore raw
Quoted 32 lines · Changcheng
Quoted 15 lines · shuah
Quoted 14 lines · Changcheng

GCC8 started emitting warning about using strncpy with number of bytes exactly equal destination size which could lead to non-zero terminated string being copied. Use "SYSFS_PATH_MAX - 1" & "SYSFS_BUS_ID_SIZE - 1" as number of bytes to ensure name is always zero-terminated.

---
v1 -> v2:
* Correct array tail index

---
   tools/usb/usbip/libsrc/usbip_common.c        | 6 ++++--
   tools/usb/usbip/libsrc/usbip_device_driver.c | 6 ++++--
   2 files changed, 8 insertions(+), 4 deletions(-)
Quoted 16 lines

tools/usb/usbip/libsrc/usbip_common.c int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev) · line 231

Quoted 13 lines
tools/usb/usbip/libsrc/usbip_common.c +4 -2
index bb424638d75b..b8d7d480595a 100644
@@ -226,8 +226,10 @@ int read_usb_device(struct udev_device *sdev, struct usbip_usb_device *udev)
   	path = udev_device_get_syspath(sdev);
   	name = udev_device_get_sysname(sdev);
-	strncpy(udev->path,  path,  SYSFS_PATH_MAX);
-	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE);
+	strncpy(udev->path,  path,  SYSFS_PATH_MAX - 1);
+	udev->path[SYSFS_PATH_MAX - 1] = '\0';
+	strncpy(udev->busid, name, SYSFS_BUS_ID_SIZE - 1);
+	udev->busid[SYSFS_BUS_ID_SIZE - 1] = '\0';

strlcpy() would be better choice here. Any reason to not use that?

Quoted 3 lines

@Shuah: linux tools link with libc which doesn't implment strlcpy yet. So tools source code can't use strlcpy function like other kernel source code.

Right I keep forgetting that. :)
Thinking about it, udev_device_get_syspath() could return null. Not related to this change anyway.

Thanks for fixing this.

Greg! Please pick this up:

thanks,
-- Shuah