From patchwork Mon Feb 5 09:12:29 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kees Cook X-Patchwork-Id: 196695 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:168b:b0:106:860b:bbdd with SMTP id ma11csp755751dyb; Mon, 5 Feb 2024 01:13:30 -0800 (PST) X-Google-Smtp-Source: AGHT+IHuWAYUhv10mRz5qdlINzOW+7MYrdhNX86Jnv7rc6IEo06Nb4QDA5t/zOysGVoxiMnDAnmF X-Received: by 2002:a17:903:32cd:b0:1d9:5b8b:f70 with SMTP id i13-20020a17090332cd00b001d95b8b0f70mr11405681plr.29.1707124410409; Mon, 05 Feb 2024 01:13:30 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707124410; cv=pass; d=google.com; s=arc-20160816; b=h+fLzM7N/nY+ZjjrnosP/jcqyiL+PBQbONhsesHmysnVp51HxP+Wzq2HrqudFzgdr5 0T4BPr4FVKzqSGIK42PEfn2iGILkFj4pNHj8tc9eRdk79AbF55ycrFnL4NTCgrrue21g zasy4nAafH6D4jDs1vjI4NNJbp1ZDBLXPVzboQ6rF4bQ3TldOmCNu8mdFI+KMUT2qb0a 63jSH+TE5tBSxeElq6U5iLKg7iRLEnBzcuCXpn9X5ONTHKCPy85Yu3AEcOz2tUF3m2V0 NgJZ1xECbhBsimY+hrCgvLjXINqIbv+sGRHxy/jCjRTdAcCw/SQVHINXSoc/yIl5J/Z/ upLA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=QphZTJ2YkJ63c2lk2h3jm8PAaMKsJdXhMlN0zVjn/Jc=; fh=2/XqIFXRgtz7/x+/eCGU+CtzcWAojwXUWjaspmI73vU=; b=vMMvGc4Z3LnaKPTocjgxQc8TXVQRDJS6f8gNDu96rYjGEPiJHaY47fP0EQo1rCqf5i wonufx47T1YYU+caDNzpICv/cjBglGaVeogoqVfYoK9CzklK0GT6vlj6n3J0eWospNG7 DXSThDY+y8M2kxCSTVyflhBUSDzSWIFtRthY/AuIRGBHq5hWa/qHKQBy2Q8mQR9tdQwZ tHOmPk6aO0dvhc1ZXufs1uEeSWDZR3cTc7I0cZR74x8FMobFJYK1Ro4TFnrUy7t1vBv0 IrSA0iqM21Uuy/gbZt1nlExYWug5Esm8+QN8YJcR6HGsON4N4BH1XrtpVhU2X+s92iMY RcGw==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=AKRgZnK1; arc=pass (i=1 spf=pass spfdomain=chromium.org dkim=pass dkdomain=chromium.org dmarc=pass fromdomain=chromium.org); spf=pass (google.com: domain of linux-kernel+bounces-52270-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52270-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org X-Forwarded-Encrypted: i=1; AJvYcCWJS0ENQVzJyTEUVlDszrN228SprNVZXq+S4dY4+Pg4zd11g8Xrvmxvaab0jfpqMiOlsRvbScYXXHx485OLSDDf7yxqcA== Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [139.178.88.99]) by mx.google.com with ESMTPS id ix20-20020a170902f81400b001d8b5747fd3si5942326plb.228.2024.02.05.01.13.30 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:13:30 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-52270-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=AKRgZnK1; arc=pass (i=1 spf=pass spfdomain=chromium.org dkim=pass dkdomain=chromium.org dmarc=pass fromdomain=chromium.org); spf=pass (google.com: domain of linux-kernel+bounces-52270-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52270-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sv.mirrors.kernel.org (Postfix) with ESMTPS id 2B2AE281C4E for ; Mon, 5 Feb 2024 09:13:30 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id C5D20134C6; Mon, 5 Feb 2024 09:12:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="AKRgZnK1" Received: from mail-pf1-f180.google.com (mail-pf1-f180.google.com [209.85.210.180]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 12D7D125AF for ; Mon, 5 Feb 2024 09:12:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.180 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707124358; cv=none; b=Hb9FjeYLAC7vwJ1u/voKGuh8PeEn7OH37X3jG0H+uOvLzkiqUQcYSNTiUl0ZIwoAAnuW1E+zErI0pLabdoZQ0nVqiTPgL6yJmm8qQbcrMhwNGdilAoX4pOzdvxGkm0/B6RFckn5bmvfkvyEdcTX5sccX2lO0ZYJoKjlI0N++nbQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707124358; c=relaxed/simple; bh=6Jgp3vxxK3Vk/XDvje4qMUZMER6LkaJQhb8c5Sf9IQw=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=LRCmKM2W/xZi32nf9whPNdQmbM2vkG0d9A7CcY/TocG7H6BifvlkJqjvxfoh95WXUP73J7KI4SgZBcgmywZmvxxqcmKkGvyyYq7gmQDrJYnZlZ7S3jfr5vB2YHKtqHz6WlRGuAMx1+SmlibMzgH/6lN+nVp6SfO4aBCd7F+eylk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=AKRgZnK1; arc=none smtp.client-ip=209.85.210.180 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Received: by mail-pf1-f180.google.com with SMTP id d2e1a72fcca58-6e0353e47daso680939b3a.3 for ; Mon, 05 Feb 2024 01:12:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1707124356; x=1707729156; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=QphZTJ2YkJ63c2lk2h3jm8PAaMKsJdXhMlN0zVjn/Jc=; b=AKRgZnK108PcD0RJAOQMZ9c4jNRKuMEECNY1exC3xIpk12XFzdRMUAISbgQvLo2dWO Y4dFQ15xwhSefVADmjYZfzFGDoZqm6x4nROmTozHji+4xfJ+IuQ8HPZkQHHzhZCpzKVX T9oqssFWZSWNKZKtd/3+BAU3gVvx84iGP3Igo= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707124356; x=1707729156; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=QphZTJ2YkJ63c2lk2h3jm8PAaMKsJdXhMlN0zVjn/Jc=; b=gyeJc9fzBn1YROAFpWED8eviw1vB0CpjM41hyBA/7aWtwf3vF3IwO8nCTF+o1PyvyE k4bOzubKWOU7xEzHAVC1pZAbq15n0CRE42l7UX7PxVn1rY8CtoVEmv9p/rdPt3CcfIYe 5oJL1bX2PMMmd0cqnRd7TttZJE8m0w1D1dBMiVYDCoc5S9iTSAQL3MnMVBOXHH+XnmAs K+VyAqrQ2w84gulPGvti7D9//e5hAQPiTABMUr8Oj7HtwthMfuPv4P/zhl7w8ZtTbOec z0cPIhecKpu9n3Ige0jDOi9HdBqD5LVRzQatdP1sZvPmL58w/FMAykVf/vndXRHozHCu hl3g== X-Gm-Message-State: AOJu0Yy4YypWbKMrQhkV5GTW+1dTMYJsFziIUH/azk3GX9TFEy7otbsp pT0RA5K8tOKetEYZfyxH0OqcH+3UKvzzWZ4A7FJRKeXBB3gsSyqSp/0WHAQm4g== X-Received: by 2002:a05:6a00:1f14:b0:6e0:4c5e:68ab with SMTP id be20-20020a056a001f1400b006e04c5e68abmr987347pfb.1.1707124356282; Mon, 05 Feb 2024 01:12:36 -0800 (PST) X-Forwarded-Encrypted: i=0; AJvYcCUgam0Sy5mL/Gq2M+QwdBOj/Tkb86Y/ythxRWM59BxWOi6iob5C608oCLu52Q4+Us97eO6CBhRL83AlT/vHwDTKdeQsltJ8HgqjsQxU2ngNVyvzV7ggO9nFIQrcsgAg/Lx6bs/pMFVPe+K5XEp4mScgRTfNnw4h866xuwA3QyBoVHvDbrYXKXid8lm4dUl5B42orbB3xVs1mdF1egmie9Fe5xsoaPuJwg== Received: from www.outflux.net ([198.0.35.241]) by smtp.gmail.com with ESMTPSA id u26-20020aa7839a000000b006dfbecb5027sm6351600pfm.171.2024.02.05.01.12.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:12:34 -0800 (PST) From: Kees Cook To: linux-hardening@vger.kernel.org Cc: Kees Cook , "Gustavo A. R. Silva" , Rasmus Villemoes , Mark Rutland , Marco Elver , linux-kernel@vger.kernel.org Subject: [PATCH v3 1/3] overflow: Adjust check_*_overflow() kern-doc to reflect results Date: Mon, 5 Feb 2024 01:12:29 -0800 Message-Id: <20240205091233.1357377-1-keescook@chromium.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240205090854.make.507-kees@kernel.org> References: <20240205090854.make.507-kees@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2673; i=keescook@chromium.org; h=from:subject; bh=6Jgp3vxxK3Vk/XDvje4qMUZMER6LkaJQhb8c5Sf9IQw=; b=owEBbQKS/ZANAwAKAYly9N/cbcAmAcsmYgBlwKZ/MG0B/D0l8I3Zre9ccIWewGWghw7fRDA6+ Ex6geHfWP6JAjMEAAEKAB0WIQSlw/aPIp3WD3I+bhOJcvTf3G3AJgUCZcCmfwAKCRCJcvTf3G3A JlIRD/0fNYHR/Q/t3GE6K/dcj/N/TszNOgrjmagwPMznODDeX79tpNgCnptKczo7nbLyqrusHDs TIOE89F3iInBnFUFCw/dDxOO3IPQftyBB+0R6nvUry3RuoAa5B9N5dvJj4LR0scO6epJkInmj1s 0tcC7bpmXvIe5RR0U1gP79Ms9RkH0OdWYsFa42F8Y5TLgAgmUuxYGd/Ay1cjXj90L5stz1LFoha ZTeIQwRFErrw4nDerDgwL3xCH/9F4Ip057DBRTkBozjY1dz4yHmsstVcZHOr8pMUhCxSCslr9Ht AI/w9Aiqcnm/RVX7OxzwbbQUY9nY1nMD7M4zpAt54GmWQgsmHDjdEcTd340QvENDIWK6t9Thr9C l5aIvCdJbS0yuZsw41HZEKVNyN9wVCbJ3bBOOh0vvzZcY0sV1TxOuh2ZnvjgqcvMLefq3GqSGVD BMFRfRxwCgf982GZCTwxMXxzIqfgEw+MO/0YCD3b9M3sxkaGsvMzIkF/8MxjvOTYzo7dBvyv46o Y77HXbXzYNpVpp/Udn+QQl5bk/kNrZF+VTfNgQJqFi8uJRFTvACk8YHLOrSrv6QfoWhq5+Vwwjf vpuoU/S63IZrqSAVIb4car+GYeboncIq86glDnp5d/Z8DHARUQhpU1+oLYbRFa62tRcWQUdWrAU H5orQF7g3va7/8Q== X-Developer-Key: i=keescook@chromium.org; a=openpgp; fpr=A5C3F68F229DD60F723E6E138972F4DFDC6DC026 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1790049686258113851 X-GMAIL-MSGID: 1790049686258113851 The check_*_overflow() helpers will return results with potentially wrapped-around values. These values have always been checked by the selftests, so avoid the confusing language in the kern-doc. The idea of "safe for use" was relative to the expectation of whether or not the caller wants a wrapped value -- the calculation itself will always follow arithmetic wrapping rules. Cc: "Gustavo A. R. Silva" Cc: linux-hardening@vger.kernel.org Signed-off-by: Kees Cook Reviewed-by: Gustavo A. R. Silva --- include/linux/overflow.h | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/include/linux/overflow.h b/include/linux/overflow.h index 7b5cf4a5cd19..4e741ebb8005 100644 --- a/include/linux/overflow.h +++ b/include/linux/overflow.h @@ -57,11 +57,9 @@ static inline bool __must_check __must_check_overflow(bool overflow) * @b: second addend * @d: pointer to store sum * - * Returns 0 on success. + * Returns 0 on success, 1 on wrap-around. * - * *@d holds the results of the attempted addition, but is not considered - * "safe for use" on a non-zero return value, which indicates that the - * sum has overflowed or been truncated. + * *@d holds the results of the attempted addition, which may wrap-around. */ #define check_add_overflow(a, b, d) \ __must_check_overflow(__builtin_add_overflow(a, b, d)) @@ -72,11 +70,9 @@ static inline bool __must_check __must_check_overflow(bool overflow) * @b: subtrahend; value to subtract from @a * @d: pointer to store difference * - * Returns 0 on success. + * Returns 0 on success, 1 on wrap-around. * - * *@d holds the results of the attempted subtraction, but is not considered - * "safe for use" on a non-zero return value, which indicates that the - * difference has underflowed or been truncated. + * *@d holds the results of the attempted subtraction, which may wrap-around. */ #define check_sub_overflow(a, b, d) \ __must_check_overflow(__builtin_sub_overflow(a, b, d)) @@ -87,11 +83,9 @@ static inline bool __must_check __must_check_overflow(bool overflow) * @b: second factor * @d: pointer to store product * - * Returns 0 on success. + * Returns 0 on success, 1 on wrap-around. * - * *@d holds the results of the attempted multiplication, but is not - * considered "safe for use" on a non-zero return value, which indicates - * that the product has overflowed or been truncated. + * *@d holds the results of the attempted multiplication, which may wrap-around. */ #define check_mul_overflow(a, b, d) \ __must_check_overflow(__builtin_mul_overflow(a, b, d)) From patchwork Mon Feb 5 09:12:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kees Cook X-Patchwork-Id: 196694 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:168b:b0:106:860b:bbdd with SMTP id ma11csp755747dyb; Mon, 5 Feb 2024 01:13:29 -0800 (PST) X-Google-Smtp-Source: AGHT+IH7EP1dNw+LHs8CXB8u769FF1VN7Mxp/bJwM58BYI2LoCpSARrMRXcMSMt2IgVa5UlW5TJO X-Received: by 2002:a05:622a:520f:b0:42c:7f4:94b5 with SMTP id dq15-20020a05622a520f00b0042c07f494b5mr5362767qtb.22.1707124409557; Mon, 05 Feb 2024 01:13:29 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707124409; cv=pass; d=google.com; s=arc-20160816; b=ywCv2+cBxwNvG9MkNVMEQaxPOSad4V1ifU84eLmU2jRzTAwvrm7/uaahVDCC0KAXZK 000sFfRqO2mFhzGiNDuDw/2SdPQWtY4ukFbWCvSN2kJC0mDmGiWgRUfcOQA0qCzphx2p Kt2F51P3pYrqyUdgmhI97cNQsm6im4GFZAtj7ITyCYAkdTg89Md83ZOGCrgbgnugBk9j EeIxvTH4GpLjGmLmzkPVMZTeFS1fNwS541I1ZjNRo7u+OGVfmLyrg5Od26GoqJO8j+WX PDfCFWOOUMdZcrAYTTYw3g0xcXSGl/r+Spr1y05qbcv11+a8sQG16rpPghTNeF5xogRe PfYA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=Rl5P1mUqQmiBnyeDfQoNPHfTfxufsKI5ULtAGp1CR1s=; fh=hnA9F4GrYJ7chBWRg4Q4IB81fECbUEr9Tvszr00evtI=; b=p6NLT+3yMuzU+4z7CW0HcCLu+0rahjVmFyfCCcc2L1R0SxKPxyTu6bKdJIgSJgm6Ez eK/UFAMOQtSXzzZlVTUe6ct6+WVs+ydIqHq3E3zCcf8sC4Imp1QKAFGhDtJSCmUd6MHd hpwejG3UR35BAQcXFZfKk1PxsC01DE+W0cxCBquY5nQ8Q3PBnWXREIsY/oB5c+WhT+TE 6jsYIQ/W8CQB6u3+4kJ63CofXfTxC4wBP3LD7Ak6K7JNrjiIGK6RS8lCtqM1spVi4fpB KQmotruT+w+2Vh9j2ge0zVn3V7ATr4bmPPsZRIdWGqJH6BabKFqUDPqG5kEqsdN2HbAp zMNA==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=Ywzu59O5; arc=pass (i=1 spf=pass spfdomain=chromium.org dkim=pass dkdomain=chromium.org dmarc=pass fromdomain=chromium.org); spf=pass (google.com: domain of linux-kernel+bounces-52269-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52269-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org X-Forwarded-Encrypted: i=1; AJvYcCVyClCWl9FLLVpBx+Tr8dMmTB1qXF2V1++aiox2gaiLgPMzFFWvrqCo7lXqeSDugY18RaYSajhZCcUpy4mhXjM/sLi4Yw== Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id s3-20020ac85cc3000000b0042a2e1312a0si8160860qta.216.2024.02.05.01.13.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:13:29 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-52269-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=Ywzu59O5; arc=pass (i=1 spf=pass spfdomain=chromium.org dkim=pass dkdomain=chromium.org dmarc=pass fromdomain=chromium.org); spf=pass (google.com: domain of linux-kernel+bounces-52269-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52269-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id 4CD8F1C20BF3 for ; Mon, 5 Feb 2024 09:13:29 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id A5F42134C4; Mon, 5 Feb 2024 09:12:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="Ywzu59O5" Received: from mail-pj1-f42.google.com (mail-pj1-f42.google.com [209.85.216.42]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CB5CC11CAD for ; Mon, 5 Feb 2024 09:12:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.42 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707124358; cv=none; b=uQ+3rqxfasCFu+WPUunKZx3NwgZEIcPCFBhhwzEfpHSmzh+2ao5+dcbqPKhKIkpjVvClPKXQdSbRpPxEYcHB+4sCAyda6YwmaX2V1bbIOYo5nbb/1TzcHm6fIe5kdWd7uw1FrMD+Wku7mvcccP7kpCnOFJyjmrWOM+HNzK7H4Eo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707124358; c=relaxed/simple; bh=Uu4zdTW2mKt9ckOwQpBzTQVr+FjHnYW3s+ZeUJaV4TY=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=Guj/0atXYuUi2DiwmvCIFyUv1Ag1GuqT1KeE1xGRLYQ8Xa9yxLzvgwFZDPwJgkOK0xE5kgmb0eipqjWghSmQMYitgpDnrXCDg9yQ6Mak6rfqHZYwG8i7khw2SxocF5WdSsdLIn8x7HsxM4SS6ia2bmxowkf+h8gwQaQdjfl9fl4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=Ywzu59O5; arc=none smtp.client-ip=209.85.216.42 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Received: by mail-pj1-f42.google.com with SMTP id 98e67ed59e1d1-296851164b0so785229a91.3 for ; Mon, 05 Feb 2024 01:12:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1707124355; x=1707729155; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Rl5P1mUqQmiBnyeDfQoNPHfTfxufsKI5ULtAGp1CR1s=; b=Ywzu59O5CKzGwQtjm4so8UlScBmDqGPGtns88AYLxwvz3+tO1LqCQjuvt8sB8Vdy3C ZgX0nC74gjOUgf3G3+ZWg6VEK7miyJ3ZOFg897bl0A162Vs12bQKGxxK0hQqbB0ZOdtJ rj2mOB80M69GFoX1nw2Xu/ow8sNZNTBFhNI48= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707124355; x=1707729155; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Rl5P1mUqQmiBnyeDfQoNPHfTfxufsKI5ULtAGp1CR1s=; b=fYwzGbfg98aWzy0LYBHEtUR5vkMHVQwldKz9qN4Xyopetbg3/LxOWup16QmA3e3vb5 Zv7xOwM7R9GkS65cCvVVvxE0eUM24srimYqzhoDB0rxqSQ8P+DVcAlHbSmTvNwpmhXZ0 djW4M//SM+b5QQz4r5MiGqDcw54qHRKj75tWgw3oQLdW7QZsc/y3TqUHR05Amabo6Fh9 gBzwug9OZo6zIAoMfr56bmDd+BFDMUmNX9w/Oug3DqLSEePvSSUkqt3vGjtVOZ40u1rF u3/5McYBEFr11GEx0fO0buADDCHc4caAiVCjHPQ9DFUrKGdgbbDYE5Lm8MP4GwP7Sg3G m7YA== X-Gm-Message-State: AOJu0YxQQLJ6Yr1TLcV4TbrCFh3PvS6iEz4LyX6tNhcrv38nICbzZBm/ sfNfYS40rAC0NQPRs6vPYBeObf6vS+dGDIaODeFd3uoWO8zwl8NPwJ5vyl9kzg== X-Received: by 2002:a17:90a:98f:b0:296:15e7:8f33 with SMTP id 15-20020a17090a098f00b0029615e78f33mr8428122pjo.3.1707124355024; Mon, 05 Feb 2024 01:12:35 -0800 (PST) X-Forwarded-Encrypted: i=0; AJvYcCXqhjiuDjmMVHPN18ECjla0RfIop9XXvPwLkP05FFQDlQSBVyHu5Ig536nrszLRwze/Tpv7vsalA1VsCe4fw9jVqp7vHWdd8gOv8HO8PXlGG5UuRnKBgexuC99PHZRg10AonuBb0etPAIkVI7mHRpELptKNgZrFGd1nsxffNtb19nKcD4+KLl5B1bNDNu4TqnjwcBDrvODLT3+l7EI9mSUvr8/s9yQz8w== Received: from www.outflux.net ([198.0.35.241]) by smtp.gmail.com with ESMTPSA id si3-20020a17090b528300b00296aa266ffesm752841pjb.31.2024.02.05.01.12.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:12:34 -0800 (PST) From: Kees Cook To: linux-hardening@vger.kernel.org Cc: Kees Cook , Rasmus Villemoes , Mark Rutland , "Gustavo A. R. Silva" , Marco Elver , linux-kernel@vger.kernel.org Subject: [PATCH v3 2/3] overflow: Introduce add_wrap(), sub_wrap(), and mul_wrap() Date: Mon, 5 Feb 2024 01:12:30 -0800 Message-Id: <20240205091233.1357377-2-keescook@chromium.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240205090854.make.507-kees@kernel.org> References: <20240205090854.make.507-kees@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=5170; i=keescook@chromium.org; h=from:subject; bh=Uu4zdTW2mKt9ckOwQpBzTQVr+FjHnYW3s+ZeUJaV4TY=; b=owEBbQKS/ZANAwAKAYly9N/cbcAmAcsmYgBlwKZ/Nm0pF6SN4QjXTBZaM3aZSgGNoHvNCa5I8 5tIXu1d1suJAjMEAAEKAB0WIQSlw/aPIp3WD3I+bhOJcvTf3G3AJgUCZcCmfwAKCRCJcvTf3G3A JvkEEACy5IItnvaa4LrGBcbUWROutsPTmPl0aCSUlLm7QkszAaPgk12TTvyYNnF9DbNyDanPqm8 1f2bs5RMLQvTkBhPHSjm6nUkym0GqENgSZ/NPbOcM1NOFNUd3BmBgfO44IKPNwl+NAvmMvoCMff cGHQrE+L0gH0SIyzX0Fdcv1kOzIna7iczsENiqouV4jeCND8tDeAv9pFkZVz8Qu1EKXTDsKL4t/ YirmrsPi2zi2SveRKigdtLK3ODOodfT8qrzbAmnpVuYGNAtkblnKs+Tto188hCfV20DPglSgpqJ X91CCRbvL1zOW64YOvD/YfyQIc+Vvn6at78f3gFodIiryXasur+E17rejaN8uTRdECFuoeBH5Rt IfechYFxFtFanjMUdqS61scoRcsqMbUqr+1i87bUgFIgfRnO1rHgeiJVUd4gtPGkUlYeREzXlQS d1tjFFfxaiNz4/qMRSHqvawfXO4dcximqzeHZdh12jTEr+cIN0kfp48Lut5ryzSWNcijIYnqIkE R7Xnz5CPiewWtuw9bx2cLxv7WzaT4fAG8jAR3zV86WOJUt02F1p862j88YFvLVjQnbCq4+dEKlT e+9hhhb/CgLsXMqvsC2dHflQ5ueI3nwpIhT0hbTkVXhRgBR4Gae4H6aPPMOtwe/XvnKPtEAabxR 887o1pblbUVWiUQ== X-Developer-Key: i=keescook@chromium.org; a=openpgp; fpr=A5C3F68F229DD60F723E6E138972F4DFDC6DC026 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1790049685093246753 X-GMAIL-MSGID: 1790049685093246753 Provide helpers that will perform wrapping addition, subtraction, or multiplication without tripping the arithmetic wrap-around sanitizers. The first argument is the type under which the wrap-around should happen with. In other words, these two calls will get very different results: mul_wrap(int, 50, 50) == 2500 mul_wrap(u8, 50, 50) == 196 Add to the selftests to validate behavior and lack of side-effects. Cc: Rasmus Villemoes Cc: Mark Rutland Cc: linux-hardening@vger.kernel.org Signed-off-by: Kees Cook Reviewed-by: Gustavo A. R. Silva --- include/linux/overflow.h | 54 ++++++++++++++++++++++++++++++++++++++++ lib/overflow_kunit.c | 23 ++++++++++++++--- 2 files changed, 73 insertions(+), 4 deletions(-) diff --git a/include/linux/overflow.h b/include/linux/overflow.h index 4e741ebb8005..9b8c05bdb788 100644 --- a/include/linux/overflow.h +++ b/include/linux/overflow.h @@ -64,6 +64,24 @@ static inline bool __must_check __must_check_overflow(bool overflow) #define check_add_overflow(a, b, d) \ __must_check_overflow(__builtin_add_overflow(a, b, d)) +/** + * add_wrap() - Intentionally perform a wrapping addition + * @type: type for result of calculation + * @a: first addend + * @b: second addend + * + * Return the potentially wrapped-around addition without + * tripping any wrap-around sanitizers that may be enabled. + */ +#define add_wrap(type, a, b) \ + ({ \ + type __val; \ + if (check_add_overflow(a, b, &__val)) { \ + /* do nothing */ \ + } \ + __val; \ + }) + /** * check_sub_overflow() - Calculate subtraction with overflow checking * @a: minuend; value to subtract from @@ -77,6 +95,24 @@ static inline bool __must_check __must_check_overflow(bool overflow) #define check_sub_overflow(a, b, d) \ __must_check_overflow(__builtin_sub_overflow(a, b, d)) +/** + * sub_wrap() - Intentionally perform a wrapping subtraction + * @type: type for result of calculation + * @a: minuend; value to subtract from + * @b: subtrahend; value to subtract from @a + * + * Return the potentially wrapped-around subtraction without + * tripping any wrap-around sanitizers that may be enabled. + */ +#define sub_wrap(type, a, b) \ + ({ \ + type __val; \ + if (check_sub_overflow(a, b, &__val)) { \ + /* do nothing */ \ + } \ + __val; \ + }) + /** * check_mul_overflow() - Calculate multiplication with overflow checking * @a: first factor @@ -90,6 +126,24 @@ static inline bool __must_check __must_check_overflow(bool overflow) #define check_mul_overflow(a, b, d) \ __must_check_overflow(__builtin_mul_overflow(a, b, d)) +/** + * mul_wrap() - Intentionally perform a wrapping multiplication + * @type: type for result of calculation + * @a: first factor + * @b: second factor + * + * Return the potentially wrapped-around multiplication without + * tripping any wrap-around sanitizers that may be enabled. + */ +#define mul_wrap(type, a, b) \ + ({ \ + type __val; \ + if (check_mul_overflow(a, b, &__val)) { \ + /* do nothing */ \ + } \ + __val; \ + }) + /** * check_shl_overflow() - Calculate a left-shifted value and check overflow * @a: Value to be shifted diff --git a/lib/overflow_kunit.c b/lib/overflow_kunit.c index c527f6b75789..064dccd973ad 100644 --- a/lib/overflow_kunit.c +++ b/lib/overflow_kunit.c @@ -258,15 +258,30 @@ DEFINE_TEST_ARRAY(s64) = { \ _of = check_ ## op ## _overflow(a, b, &_r); \ KUNIT_EXPECT_EQ_MSG(test, _of, of, \ - "expected "fmt" "sym" "fmt" to%s overflow (type %s)\n", \ + "expected check "fmt" "sym" "fmt" to%s overflow (type %s)\n", \ a, b, of ? "" : " not", #t); \ KUNIT_EXPECT_EQ_MSG(test, _r, r, \ - "expected "fmt" "sym" "fmt" == "fmt", got "fmt" (type %s)\n", \ + "expected check "fmt" "sym" "fmt" == "fmt", got "fmt" (type %s)\n", \ a, b, r, _r, #t); \ /* Check for internal macro side-effects. */ \ _of = check_ ## op ## _overflow(_a_orig++, _b_orig++, &_r); \ - KUNIT_EXPECT_EQ_MSG(test, _a_orig, _a_bump, "Unexpected " #op " macro side-effect!\n"); \ - KUNIT_EXPECT_EQ_MSG(test, _b_orig, _b_bump, "Unexpected " #op " macro side-effect!\n"); \ + KUNIT_EXPECT_EQ_MSG(test, _a_orig, _a_bump, \ + "Unexpected check " #op " macro side-effect!\n"); \ + KUNIT_EXPECT_EQ_MSG(test, _b_orig, _b_bump, \ + "Unexpected check " #op " macro side-effect!\n"); \ + \ + _r = op ## _wrap(t, a, b); \ + KUNIT_EXPECT_TRUE_MSG(test, _r == r, \ + "expected wrap "fmt" "sym" "fmt" == "fmt", got "fmt" (type %s)\n", \ + a, b, r, _r, #t); \ + /* Check for internal macro side-effects. */ \ + _a_orig = a; \ + _b_orig = b; \ + _r = op ## _wrap(t, _a_orig++, _b_orig++); \ + KUNIT_EXPECT_EQ_MSG(test, _a_orig, _a_bump, \ + "Unexpected wrap " #op " macro side-effect!\n"); \ + KUNIT_EXPECT_EQ_MSG(test, _b_orig, _b_bump, \ + "Unexpected wrap " #op " macro side-effect!\n"); \ } while (0) #define DEFINE_TEST_FUNC_TYPED(n, t, fmt) \ From patchwork Mon Feb 5 09:12:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kees Cook X-Patchwork-Id: 196696 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:168b:b0:106:860b:bbdd with SMTP id ma11csp755809dyb; Mon, 5 Feb 2024 01:13:39 -0800 (PST) X-Google-Smtp-Source: AGHT+IF0P8T2l2X0db3BZSJvNZG0w4KR42VPOt79zzv00V7sqZA5xDsfiQWwXOr9zzIG7d3mU4DT X-Received: by 2002:a17:907:7ea8:b0:a37:65ce:ac47 with SMTP id qb40-20020a1709077ea800b00a3765ceac47mr4572813ejc.66.1707124419109; Mon, 05 Feb 2024 01:13:39 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707124419; cv=pass; d=google.com; s=arc-20160816; b=D/b5R9zIzuqbGn1H4r9i7v35q57DZkuch/bhtoplXEbokvRzDnwXz0RJL30VAVxkgu fUgPmqP3I+4h+0fk2oY3U/d9x2WAnrZVM0vrNKKTSmhwbNYOo0gwrjD+oC7G5YVyACZC /BsxVVvFdrUfB3hefAu5kWBf74sWWY5eeB8h3G7uKo/Jkd/nzlhMLT98kpua9duK4fDu u46KeSyxMeTb/GGbWDrTGdP0U7bJdw2h2zxJs7f23NZWpVlbvZChpUQuk0/Srzs6e1HV 0K0fmvXcxqqY26v0D1VSPu98T9Sm2PCufEdx4gKzmuafARbUBn8bNMq2twH5MHJUaLHO d4TA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=jniMpSsyDsU5fAoe54+F89x9cv/B23a7/rxO8q9YHEU=; fh=tk8vxAgpWyKGwJyDd2xrlVk2+ri47WgchN+l/OwbA8I=; b=yKGpjiu6Z+oF9W5IMjSsAxWPaZDC4b7PG5PubPkaiaSwQC72QJarXH0uBoUOxWMI7d h1oI5pNbkDe351fOeH7VQZvqQwEzdUDcNIA/9D2bQq78HfG6HtjXJX8yOb/XBWi7kbes N4qp45RHSAqBVedZexrP5Gx9Nk8E/p/4KY1Z6kLgiVJgk86KS973YEHBuec8U/v6XXnL lsZ+IGd5nw8cK+iBoAVwN0Rj+ADxCqXffgajsMtiUfeh/7fRX602JOPirQKtNzoZP6Fy TA7FDMgxLu5Y7/4nsLAyPhywl755k8WpyDBYD4RVMbjL9eOFoc1ZLPiA//5vGGcW9cqo c1xw==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=XQfGdFVW; arc=pass (i=1 spf=pass spfdomain=chromium.org dkim=pass dkdomain=chromium.org dmarc=pass fromdomain=chromium.org); spf=pass (google.com: domain of linux-kernel+bounces-52271-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52271-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org X-Forwarded-Encrypted: i=1; AJvYcCUZY+uyqNP+awhPSPTFDICitkUWfK43dlDmg24lca7b6p8prbrJHpvK4ylJRPiHZ+xkp1W8br8glg+UnVaEhkpgpP3P0g== Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id r12-20020a170906350c00b00a37be224c02si830382eja.135.2024.02.05.01.13.38 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:13:39 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-52271-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=XQfGdFVW; arc=pass (i=1 spf=pass spfdomain=chromium.org dkim=pass dkdomain=chromium.org dmarc=pass fromdomain=chromium.org); spf=pass (google.com: domain of linux-kernel+bounces-52271-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-52271-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 814721F22E18 for ; Mon, 5 Feb 2024 09:13:38 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 7C5CF13AC7; Mon, 5 Feb 2024 09:12:42 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="XQfGdFVW" Received: from mail-pg1-f179.google.com (mail-pg1-f179.google.com [209.85.215.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 60FD5125B8 for ; Mon, 5 Feb 2024 09:12:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707124358; cv=none; b=GaHrGBQv4ELdjGmpal1lYotoFu8wtASbiLKRLVR7hkmZLBNm62ht8vudqn3CLOiG4jLKOeo7WXAJDZ8t9oqtqYz77dV09DAel1MjQAAlieWKqDTzu4H3LwiywyganKzgKkq958aho4zWI4I60BIBYlzBVeDEhaqyxxgf6GRuKyw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707124358; c=relaxed/simple; bh=BleaLxaprNdd2Ls0XK+kcFDPaLkJ843EpGNnQRcoyMU=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=i3DV9UYY0/xsT9LMZliX5sk24WQ7x15aTEinCTlQnq4lq0f1CrpezXwwHMIZ4XpP8p18gvwI+chu/Xs1bFjtCnrY61eG2V7m8UXEia9ity1lyZ0lskz72s8sN3zBt6NZzEEFGxkVvd56Cjgct2EyUGJ+rM7aRlxDATVJEZP8c8k= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=XQfGdFVW; arc=none smtp.client-ip=209.85.215.179 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Received: by mail-pg1-f179.google.com with SMTP id 41be03b00d2f7-5cddc5455aeso3585338a12.1 for ; Mon, 05 Feb 2024 01:12:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1707124356; x=1707729156; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=jniMpSsyDsU5fAoe54+F89x9cv/B23a7/rxO8q9YHEU=; b=XQfGdFVWO0p+PX12ExVRiTRWXeOYHViZ/JWxQHMN38xoApPy9zCKbb1DGOGAxtYMqc j9NWO3cR4GGqytLtYTf1bgy4MlguQcBFkHrucXIdn+WMLg2FJSOe1eDkK4GrbmV/Rbjf JkodyDGqWIKIKAC8cTY/m4JkHecomh5MNNzvw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707124356; x=1707729156; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=jniMpSsyDsU5fAoe54+F89x9cv/B23a7/rxO8q9YHEU=; b=SRXr0TLIJxoQVYpWvenhW1VtvKTGLVyAPSavNyuLbGHSzIYRoTHE8Ja3gA5SFhPOF9 JHHvktNjhJdr6j4zjRCmVpjNdSdiBIwcfWY7HJQUIKJWfPO3S4tOVHDUcPvE0Bydgs/b ngMormbH4PkvEAqnUOHM96KVmMSG3XDb6vvr0DWvbB+K1vkizImLIKklViYlqUD2YAnM bWRy7pbR4nplyVfKfcpyqIWcrBE3yxHCW4VTsEv2ey/auX0CqSNoxwn4uLwpoC1OTKS0 cYVFnGhDkK5Hu6JADp4tC0Uw+tM3VqZYaog2gKMpfzsmuBYdmZtci24u6tPqsIrwz8Ax 3/NA== X-Gm-Message-State: AOJu0YyosbjNIieSc5rogIWDz4saDR1wdmZC3CqfCm8brNrfpVLi/2yQ P7dVqEOrr09IJKqyX/L49SGD7Dg9g4GP75qJ34eST6Jwx4YoOu+WFchjlncAww== X-Received: by 2002:a05:6a21:2d8b:b0:19c:61b9:d9bb with SMTP id ty11-20020a056a212d8b00b0019c61b9d9bbmr9712518pzb.8.1707124356612; Mon, 05 Feb 2024 01:12:36 -0800 (PST) X-Forwarded-Encrypted: i=0; AJvYcCVDvA96yjO/KwcQR41cix9tuSjfftoIF+xmpKioEFUhdprdWIt0pZSh61sqHp33TIoS1UHA9/wAuFVqJCk7QKpDxgUJ9KXq4shewdbUN3sU7aQv08Gu6dD8fcnrUbhHiinpqZdJ00donD8iL/jnNk/Wgvjq7JfBxofQ+Yg/3scTTEGOLttrfvC+8+E6YMxmmLoR3IA76abHYWvdrrPMaEpiSam2wpymyQ== Received: from www.outflux.net ([198.0.35.241]) by smtp.gmail.com with ESMTPSA id r22-20020a62e416000000b006e03cce3f4asm2280702pfh.25.2024.02.05.01.12.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Feb 2024 01:12:34 -0800 (PST) From: Kees Cook To: linux-hardening@vger.kernel.org Cc: Kees Cook , Rasmus Villemoes , Mark Rutland , "Gustavo A. R. Silva" , Marco Elver , linux-kernel@vger.kernel.org Subject: [PATCH v3 3/3] overflow: Introduce inc_wrap() and dec_wrap() Date: Mon, 5 Feb 2024 01:12:31 -0800 Message-Id: <20240205091233.1357377-3-keescook@chromium.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240205090854.make.507-kees@kernel.org> References: <20240205090854.make.507-kees@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=4480; i=keescook@chromium.org; h=from:subject; bh=BleaLxaprNdd2Ls0XK+kcFDPaLkJ843EpGNnQRcoyMU=; b=owEBbQKS/ZANAwAKAYly9N/cbcAmAcsmYgBlwKZ/47AUqLm5ToJr980/JQTh0fsearVme/cqG RQaW2oif+qJAjMEAAEKAB0WIQSlw/aPIp3WD3I+bhOJcvTf3G3AJgUCZcCmfwAKCRCJcvTf3G3A Jig5D/9LTGnRArg0ixC/Igu7Weo0f3WLiXQISsIPY7j85lWdvoVeZyJ0V87CuTxxChHPBIDb0Ze g/y15S7sis0rYZa2ZtEF6dgK9GCv08iOgJbkLWO/RJ58Mcltp6AkmzpcrAbVNiV0CY3yhZzq4aE /7o3sYZfqZv4bDrUuzaCnOlBcEdcVW1jHLJIkfklpFd1Eyxoq9Ec/nsN88H4K8HrjZLpXwQpe1k cAU1LsePQNAOvkmjkBF2pm12SsTu2gehJJ31jNczjIL6LtJ9uhiOUUZ6i3KiIz0l0cNlDC3N26H YVTRkOLO11m6cL3GGORuZ5R6fNuUYCpmLvsaRjEZx4fXlHzpk9G+cqqUEgNGd9REKFcRkXXMQ85 tL0i1KFlUXs7JXdeMicgHrT6Ub+mii46osYMpJ4xzLSs7jFAzodrToS9+N3GwzMZYBxGuDI3o+3 K35QXFDSVLKhJ9fYxEmC5qppuQkWKzPqW0Q8RjEsGpRFdVreVm1vQzCi1NJ/Q49fNjljmCru+e2 9/y79fOVtlpqZMVsvRILZL79qVbGBDJ/KuMAeH4UrjBPsEJuQCoZf27NLy5CPnuJ+UBGNtIBiHn lkMMWm6QOiQcXZkC3Q9f+selb3BETCjUv1U9aR0qquKjV0fqsoSzVCSwYrhWOGSt00cP0Ongw3b aCoe6Sbbn5LaNOg== X-Developer-Key: i=keescook@chromium.org; a=openpgp; fpr=A5C3F68F229DD60F723E6E138972F4DFDC6DC026 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1790049695093627997 X-GMAIL-MSGID: 1790049695093627997 This allows replacements of the idioms "var += offset" and "var -= offset" with the inc_wrap() and dec_wrap() helpers respectively. They will avoid wrap-around sanitizer instrumentation. Add to the selftests to validate behavior and lack of side-effects. Cc: Rasmus Villemoes Cc: Mark Rutland Cc: "Gustavo A. R. Silva" Cc: linux-hardening@vger.kernel.org Signed-off-by: Kees Cook --- include/linux/overflow.h | 28 +++++++++++++++++++++++++++ lib/overflow_kunit.c | 42 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) diff --git a/include/linux/overflow.h b/include/linux/overflow.h index 9b8c05bdb788..6a4c18544ab1 100644 --- a/include/linux/overflow.h +++ b/include/linux/overflow.h @@ -82,6 +82,20 @@ static inline bool __must_check __must_check_overflow(bool overflow) __val; \ }) +/** + * inc_wrap() - Intentionally perform a wrapping increment + * @var: variable to be incremented + * @offset: amount to add + * + * Increments @var by @offset with wrap-around. Returns the resulting + * value of @var. Will not trip any wrap-around sanitizers. + */ +#define inc_wrap(var, offset) \ + ({ \ + typeof(var) *__ptr = &(var); \ + *__ptr = add_wrap(typeof(var), *__ptr, offset); \ + }) + /** * check_sub_overflow() - Calculate subtraction with overflow checking * @a: minuend; value to subtract from @@ -113,6 +127,20 @@ static inline bool __must_check __must_check_overflow(bool overflow) __val; \ }) +/** + * dec_wrap() - Intentionally perform a wrapping decrement + * @var: variable to be decremented + * @offset: amount to subtract + * + * Decrements @var by @offset with wrap-around. Returns the resulting + * value of @var. Will not trip any wrap-around sanitizers. + */ +#define dec_wrap(var, offset) \ + ({ \ + typeof(var) *__ptr = &(var); \ + *__ptr = sub_wrap(typeof(var), *__ptr, offset); \ + }) + /** * check_mul_overflow() - Calculate multiplication with overflow checking * @a: first factor diff --git a/lib/overflow_kunit.c b/lib/overflow_kunit.c index 064dccd973ad..23e37bce0022 100644 --- a/lib/overflow_kunit.c +++ b/lib/overflow_kunit.c @@ -284,14 +284,56 @@ DEFINE_TEST_ARRAY(s64) = { "Unexpected wrap " #op " macro side-effect!\n"); \ } while (0) +static int global_counter; +static void bump_counter(void) { + global_counter ++; +} + +static int get_index(void) { + volatile int index = 0; + bump_counter(); + return index; +} + +#define check_self_op(fmt, op, sym, a, b) do { \ + typeof(a + 0) _a = a; \ + typeof(b + 0) _b = b; \ + typeof(a + 0) _a_sym = a; \ + typeof(a + 0) _a_orig[1] = { a }; \ + typeof(b + 0) _b_orig = b; \ + typeof(b + 0) _b_bump = b + 1; \ + typeof(a + 0) _r; \ + \ + _a_sym sym _b; \ + _r = op ## _wrap(_a, _b); \ + KUNIT_EXPECT_TRUE_MSG(test, _r == _a_sym, \ + "expected "fmt" "#op" "fmt" == "fmt", got "fmt"\n", \ + a, b, _a_sym, _r); \ + KUNIT_EXPECT_TRUE_MSG(test, _a == _a_sym, \ + "expected "fmt" "#op" "fmt" == "fmt", got "fmt"\n", \ + a, b, _a_sym, _a); \ + /* Check for internal macro side-effects. */ \ + global_counter = 0; \ + op ## _wrap(_a_orig[get_index()], _b_orig++); \ + KUNIT_EXPECT_EQ_MSG(test, global_counter, 1, \ + "Unexpected " #op "_wrap() macro side-effect on arg1!\n"); \ + KUNIT_EXPECT_EQ_MSG(test, _b_orig, _b_bump, \ + "Unexpected " #op "_wrap() macro side-effect on arg2!\n"); \ +} while (0) + #define DEFINE_TEST_FUNC_TYPED(n, t, fmt) \ static void do_test_ ## n(struct kunit *test, const struct test_ ## n *p) \ { \ + /* check_{add,sub,mul}_overflow() and {add,sub,mul}_wrap() */ \ check_one_op(t, fmt, add, "+", p->a, p->b, p->sum, p->s_of); \ check_one_op(t, fmt, add, "+", p->b, p->a, p->sum, p->s_of); \ check_one_op(t, fmt, sub, "-", p->a, p->b, p->diff, p->d_of); \ check_one_op(t, fmt, mul, "*", p->a, p->b, p->prod, p->p_of); \ check_one_op(t, fmt, mul, "*", p->b, p->a, p->prod, p->p_of); \ + /* {inc,dec}_wrap() */ \ + check_self_op(fmt, inc, +=, p->a, p->b); \ + check_self_op(fmt, inc, +=, p->b, p->a); \ + check_self_op(fmt, dec, -=, p->a, p->b); \ } \ \ static void n ## _overflow_test(struct kunit *test) { \