From patchwork Wed Oct 25 08:38:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Potapenko X-Patchwork-Id: 157927 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:ce89:0:b0:403:3b70:6f57 with SMTP id p9csp2451774vqx; Wed, 25 Oct 2023 01:38:44 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHLsensU+ElIDD77eQR+2Tc0BwGePywOr8ZYAKDcp7pqiRKut0QHaO8UR9BA7w8Aess24YL X-Received: by 2002:a81:4e0c:0:b0:5a7:db27:7794 with SMTP id c12-20020a814e0c000000b005a7db277794mr15218687ywb.25.1698223123922; Wed, 25 Oct 2023 01:38:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698223123; cv=none; d=google.com; s=arc-20160816; b=kRrM53/xbu7lRUB8EEcsoCJjtAoFXK7YuU7oq+2D7dCclGSDiZ69sYLSfZCG3cKpIA CELmedTLa3sTo8uXc2S5FocFaTTSFgcNj4kEc7gXcCih29aF59BqlWJJPnaiutnscIiI CvxwTMeZnFTs6LuC3cPZMKXwuqP11jZ2KXFhzR1WmY4CGHzbMGYGrVOShOL2eqa1Ibna srLjq6U/XizGYrIhAGOpOYKvJlLZ2fLB1qOSGuTQmVtwqRNojWkoOthn5ZmIjQL7myew t7D/NwVZ7MbLx6r1hbcN2MklebDB8/bv4Th7Xev8KS202CisTq/ZGA6uS9ndU1xs/rhc 8p4g== 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=7RZQ/S/jTVrRUSUeijWCI7Egf5o6MgvN5jmxkKIprg8=; fh=GmoqtqK5o+3hw8duGAYBcfcrbmWz8zn7GJB0HJXGJL0=; b=uwbUmE14hvO0V/x0vqwhiYPsArzh0o8qXf22oreMW++yeEtL9XA4tlqYXuGS/n154s U57QVbOM3N8NthX7yr2LcwyTFYZgl3F7H5dbxsOKY1EcEuocIMU3aUDM1bn0M/6HOzeX OA6Mx7iPp+Kq/Clf5xgvuAtIG+1aYNlbt/oFYs++3xS7ZlWQtMVz4sH/F/Z37tKjePOa qnpVDhP4nXyrhzkv+5xSLaDWoej4nWOyBMUGtykcaQrccHGIXaMB9zofwX3WJNOkqdRd +ci4WVIHhYPdFAA9ZMIzpQdX0bWB0rUp2E5qqmNcc1WevASZMYnGO3OhrWNQ8qMkKUcG 5NGA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=NKU8wYhu; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 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 pete.vger.email (pete.vger.email. [23.128.96.36]) by mx.google.com with ESMTPS id s64-20020a815e43000000b0059f4a492ebasi11491903ywb.195.2023.10.25.01.38.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 25 Oct 2023 01:38:43 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=NKU8wYhu; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 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 (depot.vger.email [IPv6:2620:137:e000::3:0]) by pete.vger.email (Postfix) with ESMTP id CF2998029088; Wed, 25 Oct 2023 01:38:40 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at pete.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233846AbjJYIiV (ORCPT + 26 others); Wed, 25 Oct 2023 04:38:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32792 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232720AbjJYIiU (ORCPT ); Wed, 25 Oct 2023 04:38:20 -0400 Received: from mail-wr1-x449.google.com (mail-wr1-x449.google.com [IPv6:2a00:1450:4864:20::449]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D15EE9C for ; Wed, 25 Oct 2023 01:38:17 -0700 (PDT) Received: by mail-wr1-x449.google.com with SMTP id ffacd0b85a97d-32d933caa8eso2177511f8f.1 for ; Wed, 25 Oct 2023 01:38:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1698223096; x=1698827896; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=7RZQ/S/jTVrRUSUeijWCI7Egf5o6MgvN5jmxkKIprg8=; b=NKU8wYhuHe6s/GJVxB4BIoEmOD5bvotR03z7nMzT96bCwduK15eUchUWmYbLVQl5a5 e9zjE0ktEwUhr8LyYo60OJrDSPHHEorf6Gqu3TwkWSIe73QNSGgIQQyLMbTQp8fiVGAG uZlL5HIdsFXd2teynRNC903X8Kb3sIg3rfXsgyBBu5E/jtlh2upQeyIooyLw4WzcXpB8 eLGjmonvHZaim5f8aTve9DdGViiJvyNI0LTthhIIClZ88pZAUmKKamx5Yegi0KvZlqjX KLJDuBTCzS9r0GwW2GAgC6Uok+ntOoek/BPovo78NYQni8Bse7El6BVHOGfGCsxbHUUk g8sw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698223096; x=1698827896; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=7RZQ/S/jTVrRUSUeijWCI7Egf5o6MgvN5jmxkKIprg8=; b=w850uPjU/0boD15dPs3cMokTz54+cvlf6NGIzZEXyk2FvLGGxdJAOMkKZ+URGgLu9M /gilYoDGF3BBbAmFxeubKTlyv5QOqjcZOB4HJNpGBL36LxqGtHEvH4Ma9b8o7SkIMBIi CdKP+7o3eF5FDAGVGArNrWRqsuPr/bmGU3bAdTcYN4292vLNCVb/uzvMfRFTj1DpGEHB /ccIhVLcUmtuMIYc+WF3NryD9JUTddGYuVYSGJ3EAQUE5NMxrE212Wla4pwC3enc9VME 5X8HGb4V7UgUOygC3a6pit5frOTBx+Cd0q3duA1x0v64H39N0buj52/RTA+yvo6SiY9Q ffnA== X-Gm-Message-State: AOJu0Yy00ENfRTGKyYa70Wyongv7b/3vogLQnwT3EH0eoZMfnfQ+LXQF LfXaBPReCxRb+sV4QIVfOB4eyzOYplc= X-Received: from glider.muc.corp.google.com ([2a00:79e0:9c:201:541d:37f9:e2bc:817b]) (user=glider job=sendgmr) by 2002:a5d:4d07:0:b0:319:6fc6:151 with SMTP id z7-20020a5d4d07000000b003196fc60151mr115747wrt.10.1698223095931; Wed, 25 Oct 2023 01:38:15 -0700 (PDT) Date: Wed, 25 Oct 2023 10:38:11 +0200 Mime-Version: 1.0 X-Mailer: git-send-email 2.42.0.758.gaed0368e0e-goog Message-ID: <20231025083812.456916-1-glider@google.com> Subject: [PATCH v9 1/2] lib/bitmap: add bitmap_{read,write}() From: Alexander Potapenko To: glider@google.com, catalin.marinas@arm.com, will@kernel.org, pcc@google.com, andreyknvl@gmail.com, andriy.shevchenko@linux.intel.com, aleksander.lobakin@intel.com, linux@rasmusvillemoes.dk, yury.norov@gmail.com, alexandru.elisei@arm.com Cc: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, eugenis@google.com, syednwaris@gmail.com, william.gray@linaro.org, Arnd Bergmann X-Spam-Status: No, score=-8.4 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Wed, 25 Oct 2023 01:38:40 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780716010099740718 X-GMAIL-MSGID: 1780716010099740718 From: Syed Nayyar Waris The two new functions allow reading/writing values of length up to BITS_PER_LONG bits at arbitrary position in the bitmap. The code was taken from "bitops: Introduce the for_each_set_clump macro" by Syed Nayyar Waris with a number of changes and simplifications: - instead of using roundup(), which adds an unnecessary dependency on , we calculate space as BITS_PER_LONG-offset; - indentation is reduced by not using else-clauses (suggested by checkpatch for bitmap_get_value()); - bitmap_get_value()/bitmap_set_value() are renamed to bitmap_read() and bitmap_write(); - some redundant computations are omitted. Cc: Arnd Bergmann Signed-off-by: Syed Nayyar Waris Signed-off-by: William Breathitt Gray Link: https://lore.kernel.org/lkml/fe12eedf3666f4af5138de0e70b67a07c7f40338.1592224129.git.syednwaris@gmail.com/ Suggested-by: Yury Norov Co-developed-by: Alexander Potapenko Signed-off-by: Alexander Potapenko --- This patch was previously part of the "Implement MTE tag compression for swapped pages" series (https://lore.kernel.org/linux-arm-kernel/20231011172836.2579017-4-glider@google.com/T/) This patch was previously called "lib/bitmap: add bitmap_{set,get}_value()" (https://lore.kernel.org/lkml/20230720173956.3674987-2-glider@google.com/) v8: - as suggested by Andy Shevchenko, handle reads/writes of more than BITS_PER_LONG bits, add a note for 32-bit systems v7: - Address comments by Yury Norov, Andy Shevchenko, Rasmus Villemoes: - update code comments; - get rid of GENMASK(); - s/assign_bit/__assign_bit; - more vertical whitespace for better readability; - more compact code for bitmap_write() (now for real) v6: - As suggested by Yury Norov, do not require bitmap_read(..., 0) to return 0. v5: - Address comments by Yury Norov: - updated code comments and patch title/description - replace GENMASK(nbits - 1, 0) with BITMAP_LAST_WORD_MASK(nbits) - more compact bitmap_write() implementation v4: - Address comments by Andy Shevchenko and Yury Norov: - prevent passing values >= 64 to GENMASK() - fix commit authorship - change comments - check for unlikely(nbits==0) - drop unnecessary const declarations - fix kernel-doc comments - rename bitmap_{get,set}_value() to bitmap_{read,write}() --- include/linux/bitmap.h | 81 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h index 03644237e1efb..d63d5e4b4ab54 100644 --- a/include/linux/bitmap.h +++ b/include/linux/bitmap.h @@ -77,6 +77,10 @@ struct device; * bitmap_to_arr64(buf, src, nbits) Copy nbits from buf to u64[] dst * bitmap_get_value8(map, start) Get 8bit value from map at start * bitmap_set_value8(map, value, start) Set 8bit value to map at start + * bitmap_read(map, start, nbits) Read an nbits-sized value from + * map at start + * bitmap_write(map, value, start, nbits) Write an nbits-sized value to + * map at start * * Note, bitmap_zero() and bitmap_fill() operate over the region of * unsigned longs, that is, bits behind bitmap till the unsigned long @@ -599,6 +603,83 @@ static inline void bitmap_set_value8(unsigned long *map, unsigned long value, map[index] |= value << offset; } +/** + * bitmap_read - read a value of n-bits from the memory region + * @map: address to the bitmap memory region + * @start: bit offset of the n-bit value + * @nbits: size of value in bits, nonzero, up to BITS_PER_LONG + * + * Returns: value of nbits located at the @start bit offset within the @map + * memory region. + * + * Note: callers on 32-bit systems must be careful to not attempt reading more + * than sizeof(unsigned long). + */ +static inline unsigned long bitmap_read(const unsigned long *map, + unsigned long start, + unsigned long nbits) +{ + size_t index = BIT_WORD(start); + unsigned long offset = start % BITS_PER_LONG; + unsigned long space = BITS_PER_LONG - offset; + unsigned long value_low, value_high; + + if (unlikely(!nbits || nbits > BITS_PER_LONG)) + return 0; + + if (space >= nbits) + return (map[index] >> offset) & BITMAP_LAST_WORD_MASK(nbits); + + value_low = map[index] & BITMAP_FIRST_WORD_MASK(start); + value_high = map[index + 1] & BITMAP_LAST_WORD_MASK(start + nbits); + return (value_low >> offset) | (value_high << space); +} + +/** + * bitmap_write - write n-bit value within a memory region + * @map: address to the bitmap memory region + * @value: value to write, clamped to nbits + * @start: bit offset of the n-bit value + * @nbits: size of value in bits, nonzero, up to BITS_PER_LONG. + * + * bitmap_write() behaves as-if implemented as @nbits calls of __assign_bit(), + * i.e. bits beyond @nbits are ignored: + * + * for (bit = 0; bit < nbits; bit++) + * __assign_bit(start + bit, bitmap, val & BIT(bit)); + * + * Note: callers on 32-bit systems must be careful to not attempt writing more + * than sizeof(unsigned long). + */ +static inline void bitmap_write(unsigned long *map, + unsigned long value, + unsigned long start, unsigned long nbits) +{ + size_t index; + unsigned long offset; + unsigned long space; + unsigned long mask; + bool fit; + + if (unlikely(!nbits || nbits > BITS_PER_LONG)) + return; + + mask = BITMAP_LAST_WORD_MASK(nbits); + value &= mask; + offset = start % BITS_PER_LONG; + space = BITS_PER_LONG - offset; + fit = space >= nbits; + index = BIT_WORD(start); + + map[index] &= (fit ? (~(mask << offset)) : ~BITMAP_FIRST_WORD_MASK(start)); + map[index] |= value << offset; + if (fit) + return; + + map[index + 1] &= BITMAP_FIRST_WORD_MASK(start + nbits); + map[index + 1] |= (value >> space); +} + #endif /* __ASSEMBLY__ */ #endif /* __LINUX_BITMAP_H */ From patchwork Wed Oct 25 08:38:12 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Potapenko X-Patchwork-Id: 157928 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:ce89:0:b0:403:3b70:6f57 with SMTP id p9csp2451805vqx; Wed, 25 Oct 2023 01:38:47 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEGQLClFbY1pH40uGvnvU7b26ziqFI/Fq3ODo3aHz73Vrvs9h1Baoia9+GaJoDF2wEUdm/s X-Received: by 2002:a0d:eb8c:0:b0:5a8:8330:6f20 with SMTP id u134-20020a0deb8c000000b005a883306f20mr14835570ywe.23.1698223127747; Wed, 25 Oct 2023 01:38:47 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698223127; cv=none; d=google.com; s=arc-20160816; b=a0PrB52vCm5AOyIQBiMwcBKMxqgqxL00iBg5khMH2gpX4JhiUYwIK3XMmlJU5VvJmF 6skFN9LfWTlWZ6zJ83fcBqWv5mUkCgLvTs2VYX/HqdoyGlEDOMxl4Vr+TS59QYgLVDPo 9OqtLkKAMKowGDQYRiVoSLqFB4OpqdsTntVaqps4TgEMdutT8VU6CKjeYgls0vPzzRUu 6GALVkYUFKVjsoFSa32cMJaii1iBAf4WB978dluxtcYUswPzDupW8UBBZzNS+uIwhBhP TFwJxuKWZmj6mueNj53kM+WH0H/qYPOBEVRcqrmvo4/3711g03b49sqXJ0AYOS5CWhGl ZmMQ== 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:references :mime-version:in-reply-to:date:dkim-signature; bh=qB8yrxWHAh81UTz2RSBiyIh2HT/FiKCzYUt6+8G2cno=; fh=bwsiIJU4ZySHCYgdbJrawkDYkx7XsqbTjYxIEnch01E=; b=abaAWv2kqLDXxqb2HsWEAGc53wvHB2rKVvmX27OE8n+yjmqlND9Iqv0z5fA8U1yBOq M+S2eRfhXuJgpQvfCN+1WqMZkoPppkxxz2V/cHOsPRKhw8YGYRctAeazFcwrleEyMy+0 wSUvAB3MjjaEbld2aD9+4CAi0v+atxRf0+kXnN5aPlF3CwETCurswQjMp24bTLwIBnYB iCHy+DMgdl9v9JCp4DNRNdyCxLrDGyYVrOROG9imhuBjSPpBYijgLWzPla9gFKPCMyCJ Ni59yxUhwJ3XQMKB+iAg9406JdqYA7kmACwNxOlGZLdfei/mxVnu+mCg9pmnNCfknhoc cXOQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=kHQsA7qo; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:1 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 morse.vger.email (morse.vger.email. [2620:137:e000::3:1]) by mx.google.com with ESMTPS id w2-20020a817b02000000b0059f5bf19c05si10721004ywc.185.2023.10.25.01.38.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 25 Oct 2023 01:38:47 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:1 as permitted sender) client-ip=2620:137:e000::3:1; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=kHQsA7qo; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:1 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 (depot.vger.email [IPv6:2620:137:e000::3:0]) by morse.vger.email (Postfix) with ESMTP id D69CE802091B; Wed, 25 Oct 2023 01:38:44 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at morse.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233940AbjJYIiZ (ORCPT + 26 others); Wed, 25 Oct 2023 04:38:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32794 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232720AbjJYIiX (ORCPT ); Wed, 25 Oct 2023 04:38:23 -0400 Received: from mail-wm1-x349.google.com (mail-wm1-x349.google.com [IPv6:2a00:1450:4864:20::349]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 969759C for ; Wed, 25 Oct 2023 01:38:20 -0700 (PDT) Received: by mail-wm1-x349.google.com with SMTP id 5b1f17b1804b1-4083a670d25so38300135e9.0 for ; Wed, 25 Oct 2023 01:38:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1698223099; x=1698827899; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=qB8yrxWHAh81UTz2RSBiyIh2HT/FiKCzYUt6+8G2cno=; b=kHQsA7qolOWtP+yl3qebczcFLWcIcWcT7CCECO/PlQ6nBdpRGMAUxbEDX+ptZLNEen wjxty13x4Uqwwgaq4Rih3CBjnimugwg9NTjA5VGMBHqs0Hql3qtYNidxbCeIN5OMeAQs nvyAQyA5OMD1Kd5CFhqAYfwSVrAOtjYTii1mDw2V1t4xLOmm8wUKmQ/Ehxyws31MqRAh BMuiIZRxFmwv6SA4HVr5QzL+tf5apmu6wc2o7dSlKFC9lRoho6Iv2He9nH9AjUJ/0tNu QyySzZIySgNTFCfxAUCpwXUT7XcMjXexC9AS4RA+eyC8kexRDb3uHhDjZOS59DID0w+W 7DAg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698223099; x=1698827899; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=qB8yrxWHAh81UTz2RSBiyIh2HT/FiKCzYUt6+8G2cno=; b=m8r8xiASessi5xU6yldm9X4VuTgmYnqWSb60RUFb9L0McFXVTKxEATLNktmxyw4aq2 jR55abdHchFaIWnclV/7iEi4qEtGn04vhe5G2IpKU3WNgrt0+Y5xq4YGindXdFTBXODd wtrVoZLNqw725Hmajh6037Ko/l/Vul+QJ8FprShNFnFAVTOKciptXFicnffD6NU+pAH1 2xlfI0zMM9CYFp07UGep650BrrOLUOD+CG+nShIoAYGP4ETKjeFTUVJu7pAmrZc0lDkK 1K5aZWdugwsnkHYugMCN0LmFHEQoP1Cp5xwOKph5hRJNdXDufQ90JkYun3SYF/9WM6tH GFPg== X-Gm-Message-State: AOJu0YxGAQoorLFX3w2gOMG/g9VksOjr19Zks/E26Cc1r+/mmPDFvcYc rvxuJjkQP0WzJsgrorms/oCrb09y/38= X-Received: from glider.muc.corp.google.com ([2a00:79e0:9c:201:541d:37f9:e2bc:817b]) (user=glider job=sendgmr) by 2002:a1c:7208:0:b0:405:37bb:d952 with SMTP id n8-20020a1c7208000000b0040537bbd952mr179583wmc.2.1698223098968; Wed, 25 Oct 2023 01:38:18 -0700 (PDT) Date: Wed, 25 Oct 2023 10:38:12 +0200 In-Reply-To: <20231025083812.456916-1-glider@google.com> Mime-Version: 1.0 References: <20231025083812.456916-1-glider@google.com> X-Mailer: git-send-email 2.42.0.758.gaed0368e0e-goog Message-ID: <20231025083812.456916-2-glider@google.com> Subject: [PATCH v9 2/2] lib/test_bitmap: add tests for bitmap_{read,write}() From: Alexander Potapenko To: glider@google.com, catalin.marinas@arm.com, will@kernel.org, pcc@google.com, andreyknvl@gmail.com, andriy.shevchenko@linux.intel.com, aleksander.lobakin@intel.com, linux@rasmusvillemoes.dk, yury.norov@gmail.com, alexandru.elisei@arm.com Cc: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, eugenis@google.com, syednwaris@gmail.com, william.gray@linaro.org X-Spam-Status: No, score=-8.4 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on morse.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (morse.vger.email [0.0.0.0]); Wed, 25 Oct 2023 01:38:44 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780716014335698662 X-GMAIL-MSGID: 1780716014335698662 Add basic tests ensuring that values can be added at arbitrary positions of the bitmap, including those spanning into the adjacent unsigned longs. Two new performance tests, test_bitmap_read_perf() and test_bitmap_write_perf(), can be used to assess future performance improvements of bitmap_read() and bitmap_write(): [ 0.431119][ T1] test_bitmap: Time spent in test_bitmap_read_perf: 615253 [ 0.433197][ T1] test_bitmap: Time spent in test_bitmap_write_perf: 916313 (numbers from a Intel(R) Xeon(R) Gold 6154 CPU @ 3.00GHz machine running QEMU). Signed-off-by: Alexander Potapenko Reviewed-by: Andy Shevchenko --- This patch was previously part of the "Implement MTE tag compression for swapped pages" series (https://lore.kernel.org/linux-arm-kernel/20231011172836.2579017-4-glider@google.com/T/) This patch was previously called "lib/test_bitmap: add tests for bitmap_{set,get}_value()" (https://lore.kernel.org/lkml/20230720173956.3674987-3-glider@google.com/) and "lib/test_bitmap: add tests for bitmap_{set,get}_value_unaligned" (https://lore.kernel.org/lkml/20230713125706.2884502-3-glider@google.com/) v9: - use WRITE_ONCE() to prevent optimizations in test_bitmap_read_perf() - update patch description v8: - as requested by Andy Shevchenko, add tests for reading/writing sizes > BITS_PER_LONG v7: - as requested by Yury Norov, add performance tests for bitmap_read() and bitmap_write() v6: - use bitmap API to initialize test bitmaps - as requested by Yury Norov, do not check the return value of bitmap_read(..., 0) - fix a compiler warning on 32-bit systems v5: - update patch title - address Yury Norov's comments: - rename the test cases - factor out test_bitmap_write_helper() to test writing over different background patterns; - add a test case copying a nontrivial value bit-by-bit; - drop volatile v4: - Address comments by Andy Shevchenko: added Reviewed-by: and a link to the previous discussion - Address comments by Yury Norov: - expand the bitmap to catch more corner cases - add code testing that bitmap_set_value() does not touch adjacent bits - add code testing the nbits==0 case - rename bitmap_{get,set}_value() to bitmap_{read,write}() v3: - switch to using bitmap_{set,get}_value() - change the expected bit pattern in test_set_get_value(), as the test was incorrectly assuming 0 is the LSB. --- lib/test_bitmap.c | 177 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) diff --git a/lib/test_bitmap.c b/lib/test_bitmap.c index f2ea9f30c7c5d..a4195c7376840 100644 --- a/lib/test_bitmap.c +++ b/lib/test_bitmap.c @@ -71,6 +71,17 @@ __check_eq_uint(const char *srcfile, unsigned int line, return true; } +static bool __init +__check_eq_ulong(const char *srcfile, unsigned int line, + const unsigned long exp_ulong, unsigned long x) +{ + if (exp_ulong != x) { + pr_err("[%s:%u] expected %lu, got %lu\n", + srcfile, line, exp_ulong, x); + return false; + } + return true; +} static bool __init __check_eq_bitmap(const char *srcfile, unsigned int line, @@ -186,6 +197,7 @@ __check_eq_str(const char *srcfile, unsigned int line, }) #define expect_eq_uint(...) __expect_eq(uint, ##__VA_ARGS__) +#define expect_eq_ulong(...) __expect_eq(ulong, ##__VA_ARGS__) #define expect_eq_bitmap(...) __expect_eq(bitmap, ##__VA_ARGS__) #define expect_eq_pbl(...) __expect_eq(pbl, ##__VA_ARGS__) #define expect_eq_u32_array(...) __expect_eq(u32_array, ##__VA_ARGS__) @@ -1222,6 +1234,168 @@ static void __init test_bitmap_const_eval(void) BUILD_BUG_ON(~var != ~BIT(25)); } +/* + * Test bitmap should be big enough to include the cases when start is not in + * the first word, and start+nbits lands in the following word. + */ +#define TEST_BIT_LEN (1000) + +/* + * Helper function to test bitmap_write() overwriting the chosen byte pattern. + */ +static void __init test_bitmap_write_helper(const char *pattern) +{ + DECLARE_BITMAP(bitmap, TEST_BIT_LEN); + DECLARE_BITMAP(exp_bitmap, TEST_BIT_LEN); + DECLARE_BITMAP(pat_bitmap, TEST_BIT_LEN); + unsigned long w, r, bit; + int i, n, nbits; + + /* + * Only parse the pattern once and store the result in the intermediate + * bitmap. + */ + bitmap_parselist(pattern, pat_bitmap, TEST_BIT_LEN); + + /* + * Check that writing a single bit does not accidentally touch the + * adjacent bits. + */ + for (i = 0; i < TEST_BIT_LEN; i++) { + bitmap_copy(bitmap, pat_bitmap, TEST_BIT_LEN); + bitmap_copy(exp_bitmap, pat_bitmap, TEST_BIT_LEN); + for (bit = 0; bit <= 1; bit++) { + bitmap_write(bitmap, bit, i, 1); + __assign_bit(i, exp_bitmap, bit); + expect_eq_bitmap(exp_bitmap, bitmap, + TEST_BIT_LEN); + } + } + + /* Ensure writing 0 bits does not change anything. */ + bitmap_copy(bitmap, pat_bitmap, TEST_BIT_LEN); + bitmap_copy(exp_bitmap, pat_bitmap, TEST_BIT_LEN); + for (i = 0; i < TEST_BIT_LEN; i++) { + bitmap_write(bitmap, ~0UL, i, 0); + expect_eq_bitmap(exp_bitmap, bitmap, TEST_BIT_LEN); + } + + for (nbits = BITS_PER_LONG; nbits >= 1; nbits--) { + w = IS_ENABLED(CONFIG_64BIT) ? 0xdeadbeefdeadbeefUL + : 0xdeadbeefUL; + w >>= (BITS_PER_LONG - nbits); + for (i = 0; i <= TEST_BIT_LEN - nbits; i++) { + bitmap_copy(bitmap, pat_bitmap, TEST_BIT_LEN); + bitmap_copy(exp_bitmap, pat_bitmap, TEST_BIT_LEN); + for (n = 0; n < nbits; n++) + __assign_bit(i + n, exp_bitmap, w & BIT(n)); + bitmap_write(bitmap, w, i, nbits); + expect_eq_bitmap(exp_bitmap, bitmap, TEST_BIT_LEN); + r = bitmap_read(bitmap, i, nbits); + expect_eq_ulong(r, w); + } + } +} + +static void __init test_bitmap_read_write(void) +{ + unsigned char *pattern[3] = {"", "all:1/2", "all"}; + DECLARE_BITMAP(bitmap, TEST_BIT_LEN); + unsigned long zero_bits = 0, bits_per_long = BITS_PER_LONG; + unsigned long val; + int i, pi; + + /* + * Reading/writing zero bits should not crash the kernel. + * READ_ONCE() prevents constant folding. + */ + bitmap_write(NULL, 0, 0, READ_ONCE(zero_bits)); + /* Return value of bitmap_read() is undefined here. */ + bitmap_read(NULL, 0, READ_ONCE(zero_bits)); + + /* + * Reading/writing more than BITS_PER_LONG bits should not crash the + * kernel. READ_ONCE() prevents constant folding. + */ + bitmap_write(NULL, 0, 0, READ_ONCE(bits_per_long) + 1); + /* Return value of bitmap_read() is undefined here. */ + bitmap_read(NULL, 0, READ_ONCE(bits_per_long) + 1); + + /* + * Ensure that bitmap_read() reads the same value that was previously + * written, and two consequent values are correctly merged. + * The resulting bit pattern is asymmetric to rule out possible issues + * with bit numeration order. + */ + for (i = 0; i < TEST_BIT_LEN - 7; i++) { + bitmap_zero(bitmap, TEST_BIT_LEN); + + bitmap_write(bitmap, 0b10101UL, i, 5); + val = bitmap_read(bitmap, i, 5); + expect_eq_ulong(0b10101UL, val); + + bitmap_write(bitmap, 0b101UL, i + 5, 3); + val = bitmap_read(bitmap, i + 5, 3); + expect_eq_ulong(0b101UL, val); + + val = bitmap_read(bitmap, i, 8); + expect_eq_ulong(0b10110101UL, val); + } + + for (pi = 0; pi < ARRAY_SIZE(pattern); pi++) + test_bitmap_write_helper(pattern[pi]); +} + +static void __init test_bitmap_read_perf(void) +{ + DECLARE_BITMAP(bitmap, TEST_BIT_LEN); + unsigned int cnt, nbits, i; + unsigned long val; + ktime_t time; + + bitmap_fill(bitmap, TEST_BIT_LEN); + time = ktime_get(); + for (cnt = 0; cnt < 5; cnt++) { + for (nbits = 1; nbits <= BITS_PER_LONG; nbits++) { + for (i = 0; i < TEST_BIT_LEN; i++) { + if (i + nbits > TEST_BIT_LEN) + break; + /* + * Prevent the compiler from optimizing away the + * bitmap_read() by using its value. + */ + WRITE_ONCE(val, bitmap_read(bitmap, i, nbits)); + } + } + } + time = ktime_get() - time; + pr_err("Time spent in %s:\t%llu\n", __func__, time); +} + +static void __init test_bitmap_write_perf(void) +{ + DECLARE_BITMAP(bitmap, TEST_BIT_LEN); + unsigned int cnt, nbits, i; + unsigned long val = 0xfeedface; + ktime_t time; + + bitmap_zero(bitmap, TEST_BIT_LEN); + time = ktime_get(); + for (cnt = 0; cnt < 5; cnt++) { + for (nbits = 1; nbits <= BITS_PER_LONG; nbits++) { + for (i = 0; i < TEST_BIT_LEN; i++) { + if (i + nbits > TEST_BIT_LEN) + break; + bitmap_write(bitmap, val, i, nbits); + } + } + } + time = ktime_get() - time; + pr_err("Time spent in %s:\t%llu\n", __func__, time); +} + +#undef TEST_BIT_LEN + static void __init selftest(void) { test_zero_clear(); @@ -1237,6 +1411,9 @@ static void __init selftest(void) test_bitmap_cut(); test_bitmap_print_buf(); test_bitmap_const_eval(); + test_bitmap_read_write(); + test_bitmap_read_perf(); + test_bitmap_write_perf(); test_find_nth_bit(); test_for_each_set_bit();