igb: replace deprecated strncpy with strscpy
authorJustin Stitt <justinstitt@google.com>
Tue, 17 Oct 2023 19:04:09 +0000 (12:04 -0700)
committerJakub Kicinski <kuba@kernel.org>
Thu, 19 Oct 2023 01:10:17 +0000 (18:10 -0700)
`strncpy` is deprecated for use on NUL-terminated destination strings
[1] and as such we should prefer more robust and less ambiguous string
interfaces.

We see that netdev->name is expected to be NUL-terminated based on its
usage with format strings:
|       sprintf(q_vector->name, "%s-TxRx-%u", netdev->name,
|               q_vector->rx.ring->queue_index);

Furthermore, NUL-padding is not required as netdev is already
zero-allocated:
|       netdev = alloc_etherdev_mq(sizeof(struct igb_adapter),
|                                  IGB_MAX_TX_QUEUES);
...
alloc_etherdev_mq() -> alloc_etherdev_mqs() -> alloc_netdev_mqs() ...
|       p = kvzalloc(alloc_size, GFP_KERNEL_ACCOUNT | __GFP_RETRY_MAYFAIL);

Considering the above, a suitable replacement is `strscpy` [2] due to
the fact that it guarantees NUL-termination on the destination buffer
without unnecessarily NUL-padding.

Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings
Link: https://manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
Link: https://github.com/KSPP/linux/issues/90
Signed-off-by: Justin Stitt <justinstitt@google.com>
Tested-by: Pucha Himasekhar Reddy <himasekharx.reddy.pucha@intel.com> (A Contingent worker at Intel)
Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Link: https://lore.kernel.org/r/20231017190411.2199743-8-jacob.e.keller@intel.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
drivers/net/ethernet/intel/igb/igb_main.c

index fdadf3e84f5990846fdf10794d4aba72bd510331..db54453e19461c5222e37bb5d7952b18dd5bcd81 100644 (file)
@@ -3263,7 +3263,7 @@ static int igb_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
        igb_set_ethtool_ops(netdev);
        netdev->watchdog_timeo = 5 * HZ;
 
-       strncpy(netdev->name, pci_name(pdev), sizeof(netdev->name) - 1);
+       strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name));
 
        netdev->mem_start = pci_resource_start(pdev, 0);
        netdev->mem_end = pci_resource_end(pdev, 0);