From patchwork Thu Jul 27 22:09:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Justin Stitt X-Patchwork-Id: 127240 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:918b:0:b0:3e4:2afc:c1 with SMTP id s11csp63117vqg; Thu, 27 Jul 2023 16:09:07 -0700 (PDT) X-Google-Smtp-Source: APBJJlH+RsFhM61G4owFIWrtWXXg0JxgzozMd1skUqcCh1VmJ0pxy3j1eYNRyWG2lIQx6qGa2HBY X-Received: by 2002:a05:6a20:3953:b0:132:9783:452e with SMTP id r19-20020a056a20395300b001329783452emr86484pzg.12.1690499346911; Thu, 27 Jul 2023 16:09:06 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1690499346; cv=none; d=google.com; s=arc-20160816; b=bNKi9DrL+djIsxWotn04JV3S6V7SQ7OC2vNEKVWjWozgMToahPD5FcKYPSWB4s+iMU O13wDI+Rum2ZeZDewa0JmMlYsTYpv5m2iBE34UcQ1bQ2mWdZT2FWM8rXRBWFHiKNjaco vtf5P0aCnci4kywT5Cyh0WWKDX6b4Xg5OVVZ2IWHQPYpc8oNC3aXKTo16Z6keWtXdtHK WUG9RizUxlf7xAtyh/zaEx3xX6rUqTmg2hQ97JMFPuenS8PszG7B1r6Pxyvl8ewDNHmC 89FTV97EhVpOfWgdFgzGxjua4PlhwkT8XGQo3cug5baDmjBak5sWU+RbyHvoHSJW7U4a nCLA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:mime-version:date :dkim-signature; bh=k4cN8fzY539FysYzQlSA0Pbs/oY5p0DEsZqLCjbwVvw=; fh=44A154qH/kdy6ljywj3R0pmXDuILMvNP4QBgKm/ygTU=; b=MUGHwp8lVB4vNB1AAEQ3PofXNQwC/nKTbB2r5zLs2oeYvNpaXBUwiT0R23TMKQYa/e 7rVtS4FUzoWQhKinUYzlIiG+3OFEw1OX17lwnRn3rxUyE83ixqjS6JseNBsftpHYbaRF hpNgXzGcx2r6gg1NOyRYWPTwPWcnSnNkWgOZH8pS1s6uiiAcc88hGvodGglkc7d8+yNH fujonNAHasrNFq5GvgEoGmNv0hIcn/ChphQl0udr0Fw683ITAZ94Bhux2ySpB6Q2c36K QgSlg/PkNiAiyLj5r+t4RtEI+ELppn8EOGLxFUfdG0HiWtK3G0ECIyBz6+m2gPZNCTTD 6a8Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b=1invnO00; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id y23-20020a63de57000000b0055c8fd5fe00si1842939pgi.886.2023.07.27.16.08.54; Thu, 27 Jul 2023 16:09:06 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20221208 header.b=1invnO00; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232405AbjG0WJh (ORCPT + 99 others); Thu, 27 Jul 2023 18:09:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39226 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229902AbjG0WJg (ORCPT ); Thu, 27 Jul 2023 18:09:36 -0400 Received: from mail-yb1-xb49.google.com (mail-yb1-xb49.google.com [IPv6:2607:f8b0:4864:20::b49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 68BAD271E for ; Thu, 27 Jul 2023 15:09:35 -0700 (PDT) Received: by mail-yb1-xb49.google.com with SMTP id 3f1490d57ef6-d1ebc896bd7so1345015276.2 for ; Thu, 27 Jul 2023 15:09:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1690495774; x=1691100574; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=k4cN8fzY539FysYzQlSA0Pbs/oY5p0DEsZqLCjbwVvw=; b=1invnO00XPFQo37nw+5PVQYz/KWJmJcQsHrAYLME6DNvlNc8mwD1kaP75zqLZyCgZF EEEkkLI1LSoHeQWteR7EOe2n5YElqxQ60OSuBTmyG+546N2uzZ4mfVr4LMfVLAu6vy0f Zvpyzfj6BM3ixLl6ryogT4cDvc0yH+covctlWW1es5tDA3xfUAonpRHprfuoYN96PRBh mrUUvWenRvbSOMenwKpah0ZQvYQYYy95lKiSvSAc8fkMcwRpdHvRuCspQ5KX/BWNZJ+k 1Mt3QQyU09iMkwcMRSKXkUeeC1Bj/Ty0/HIY78A1fVqNWVOwA8yVs4HgNONieHi2yl6H SOLA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1690495774; x=1691100574; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=k4cN8fzY539FysYzQlSA0Pbs/oY5p0DEsZqLCjbwVvw=; b=SPcbluBoLskFDxK1wjf9NjYi83wJsk+n1xWWq5B6dB8lnspe3n2Xh6rv0Ln82mQW+Y hh+6yF0A14i3J1aDRilQ0KbfG8GZ1aMl4OGo+VxmogWXLdGQGRK9gkbQeUeotyWzmox+ CHhOtf8IhbfG8zxWe33GC3D8rlZxGg8WJTi35lHIuGx35ZneJmPCdmE3YjecfESsHGaa MW2nKdXSVBh7N88XHX1n6xLeetkUZBzKEyvfPbTyMcn5qkNv0jjOc1jNM19mja3Wsmwb 99GrYy1fmWI+ElxQ9LIbil5jwtY+IyWq5ucP0KhDPug5MWIhOlJjlprmrXJ0teMEl2SN N8cw== X-Gm-Message-State: ABy/qLZdZaxGtUZeQzQFgc8GSTlOSC73nQkHFZZ37CNjnlSTok11N7Mu OKecK4yucOGd3dJ61ZCyrVaA6RJqMPxMpifUvw== X-Received: from jstitt-linux1.c.googlers.com ([fda3:e722:ac3:cc00:2b:ff92:c0a8:23b5]) (user=justinstitt job=sendgmr) by 2002:a25:abf2:0:b0:d07:f1ed:521a with SMTP id v105-20020a25abf2000000b00d07f1ed521amr3818ybi.4.1690495774661; Thu, 27 Jul 2023 15:09:34 -0700 (PDT) Date: Thu, 27 Jul 2023 22:09:29 +0000 Mime-Version: 1.0 X-B4-Tracking: v=1; b=H4sIABjrwmQC/x3MQQqEMAxG4atI1gZ+6zCiVxEXrY1jNlUaFEG8u 2WW3+K9m0yyitFQ3ZTlVNMtFTR1RfPq009YYzE5uBad69i2I0U+LHCYowPAHyC0+ML3S0+l27M sev2f4/Q8L8MihdBjAAAA X-Developer-Key: i=justinstitt@google.com; a=ed25519; pk=tC3hNkJQTpNX/gLKxTNQKDmiQl6QjBNCGKJINqAdJsE= X-Developer-Signature: v=1; a=ed25519-sha256; t=1690495773; l=2722; i=justinstitt@google.com; s=20230717; h=from:subject:message-id; bh=oD0r9GQJcI4a0oPPFKD+f4eCazsB8WXRECfFQ/3Qn80=; b=RMEEkMB9gj5yDuIGuIqJVfiAW714ytVo21T7+/g2zrDgaM+Trm12x329hvrQ6qpkXQkBKdNp7 h1YTuOzeph4DYE6Y7PJqPk4FGt00qNiQKla88lXSQoet8fLsPbVG5Uu X-Mailer: b4 0.12.3 Message-ID: <20230727-sound-usb-bcd2000-v1-1-0dc73684b2f0@google.com> Subject: [PATCH] ALSA: bcd2000: refactor deprecated strncpy From: Justin Stitt To: Jaroslav Kysela , Takashi Iwai Cc: alsa-devel@alsa-project.org, linux-kernel@vger.kernel.org, Justin Stitt X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,USER_IN_DEF_DKIM_WL autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1772617042810851852 X-GMAIL-MSGID: 1772617042810851852 `strncpy` is deprecated for use on NUL-terminated destination strings [1]. A suitable replacement is `strscpy` [2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ always the case for `strncpy`! It should be noted that, in this case, the destination buffer has a length strictly greater than the source string. Moreover, the source string is NUL-terminated (and so is the destination) which means there was no real bug happening here. Nonetheless, this patch would get us one step closer to eliminating the `strncpy` API in the kernel, as its use is too ambiguous. We need to favor less ambiguous replacements such as: strscpy, strscpy_pad, strtomem and strtomem_pad (amongst others). Technically, my patch yields subtly different behavior. The original implementation with `strncpy` would fill the entire destination buffer with null bytes [3] while `strscpy` will leave the junk, uninitialized bytes trailing after the _mandatory_ NUL-termination. So, if somehow `card->driver` or `card->shortname` require this NUL-padding behavior then `strscpy_pad` should be used. My interpretation, though, is that the aforementioned fields are just fine as NUL-terminated strings. Please correct my assumptions if needed and I'll send in a v2. [1]: www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [2]: manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html [3]: https://linux.die.net/man/3/strncpy Link: https://github.com/KSPP/linux/issues/90 Link: https://lore.kernel.org/r/20230727-sound-xen-v1-1-89dd161351f1@google.com (related ALSA patch) Signed-off-by: Justin Stitt --- sound/usb/bcd2000/bcd2000.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) --- base-commit: 57012c57536f8814dec92e74197ee96c3498d24e change-id: 20230727-sound-usb-bcd2000-400b3060a9f9 Best regards, -- Justin Stitt diff --git a/sound/usb/bcd2000/bcd2000.c b/sound/usb/bcd2000/bcd2000.c index 7aec0a95c609..392b4d8e9e76 100644 --- a/sound/usb/bcd2000/bcd2000.c +++ b/sound/usb/bcd2000/bcd2000.c @@ -395,8 +395,8 @@ static int bcd2000_probe(struct usb_interface *interface, snd_card_set_dev(card, &interface->dev); - strncpy(card->driver, "snd-bcd2000", sizeof(card->driver)); - strncpy(card->shortname, "BCD2000", sizeof(card->shortname)); + strscpy(card->driver, "snd-bcd2000", sizeof(card->driver)); + strscpy(card->shortname, "BCD2000", sizeof(card->shortname)); usb_make_path(bcd2k->dev, usb_path, sizeof(usb_path)); snprintf(bcd2k->card->longname, sizeof(bcd2k->card->longname), "Behringer BCD2000 at %s",