From patchwork Mon Oct 30 15:32:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Potapenko X-Patchwork-Id: 159788 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp2302811vqb; Mon, 30 Oct 2023 08:32:24 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFAEDms/Rb5rvIT9sS+kyBZEcseidOuNdWcYu+M9vXGOJHigrNs+Pcn8rWWm3OE/SVgqP+L X-Received: by 2002:a17:902:d492:b0:1cc:361b:7b10 with SMTP id c18-20020a170902d49200b001cc361b7b10mr3276324plg.24.1698679943912; Mon, 30 Oct 2023 08:32:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698679943; cv=none; d=google.com; s=arc-20160816; b=NupNn7aHI+ddlsbKZbAnCzEdJG67CwM9RUp4QzVa9eh+AvuUxyCww/7x2Z1GojjYRK wxC2fDUsG0w96Y47MS64mWaDq/2VSBxvsX78TsmxAETzeqA0BsRRgZUsudw01kKj69aq h3u3VLO6Q0kZaF614uxCaV9DpEIuTERyZDqvuus/IMQxD3BjN19BQZUSSPm5Glm1pdVi JNj0lidR+GXkK+dbg+yVlQwdMDz0dulRykYXuSaUvOBsj9lMGl57XmgBMgotExwj/P65 HU3GPhKrKI5EURmBjxmQ6Is7XPHDTEY2J7IzK6BNoQKBZpydTe6e3nyr08Iz5WtoBSg8 59PQ== 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=6N1/Pi/gcjpAA6FjFn+3l/Xt1rwHVQqRPaAle2Pb3pE=; fh=GmoqtqK5o+3hw8duGAYBcfcrbmWz8zn7GJB0HJXGJL0=; b=usp8H4OaiAZSAVD+bNBGPyJVzhAceQqaLeaSqqgRKSiNaASfJp4YRDq6XJ1uHGJi/+ +2HL5Hd7LGVOdaGx1nRRxF7cvF1QK6EX0/V1R4Sm104YIjFcQpbFRu4LFcAqN7dWvm2F /gLIaENTPoMjV50PwNs56yirmOFR34j+0Q4c1xEP1OZkrwrocyux9aBC44oSrCBYfN9E bmEHycjhW/H+brA2m0ihGajIoiqNzLgLQUjZsvaay84dggmjdwS/USny6UtpX4jlNm+W jyNFjXgL9m7daeHu6GXmtcsxMCQGJ/kJEAQHd/0XdVob6MN82vTTPtXo6IK2N8PKWj5d yAkQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=PDevyMiF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 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 snail.vger.email (snail.vger.email. [2620:137:e000::3:7]) by mx.google.com with ESMTPS id h21-20020a170902f7d500b001c32fe6cdf9si4265959plw.386.2023.10.30.08.32.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Oct 2023 08:32:23 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=PDevyMiF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 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 snail.vger.email (Postfix) with ESMTP id C7A51806CC3C; Mon, 30 Oct 2023 08:32:22 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233652AbjJ3PcT (ORCPT + 32 others); Mon, 30 Oct 2023 11:32:19 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46404 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231395AbjJ3PcS (ORCPT ); Mon, 30 Oct 2023 11:32:18 -0400 Received: from mail-yw1-x114a.google.com (mail-yw1-x114a.google.com [IPv6:2607:f8b0:4864:20::114a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B276EA9 for ; Mon, 30 Oct 2023 08:32:15 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-5afacc566f3so33968447b3.3 for ; Mon, 30 Oct 2023 08:32:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1698679935; x=1699284735; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=6N1/Pi/gcjpAA6FjFn+3l/Xt1rwHVQqRPaAle2Pb3pE=; b=PDevyMiFtadfy1oGCZNkRZSCcoVpLXLoegg6AfkcOvk6dE9LGuybfvqE+6vVbeDdNV bx346ysh6hlIZ2bGTlBKIldqd4GAbydAmfg8cSmmmcAM4xYirWQqsCBg1l+XPQVONuIo ql0kcXaOwGIRsxjr2t0JeyH8skrKfveAh2G0eCDK61e8bVAp6OqaS11lLox1TRy9OfCw GhBDlmLueJtS6ifsR1akumvSAXTPmq9utJh5ZEbUXwlsZoXfNdtk274hvnRRPcxFj2tg MDGjcQPbQZs6B2JpusQT9vrWXT36ebkCFqrnsBRJG5G41LirpiB5MA7lEjAPR/9nnY3Q 5Qlw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698679935; x=1699284735; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=6N1/Pi/gcjpAA6FjFn+3l/Xt1rwHVQqRPaAle2Pb3pE=; b=AzaMPILwC71jtqbDugMDxatR6Qpy3LvKW8MS74pl5SFOsNGSA3miIGhu0GjpfhaLJK o6ZvWbA0qkeaVjo0qtIw6tsSzzoyH23WSQUI0JZzWKIYWQoyJ9Kce/ugQGU2LG01xaOG yLwG0XUP0Dn+0Ya3uaScLLGh5e11ZpyudsJorsoofOkQvOAAKogTcr6WManYPKL8yAkR NjqWmWHAV4KyYT0Mocn1mfFc7w1RjpQ4Y/7E7FfLmj77KLtlr/IEH0lbSW6lD3vTzrNy Ck7Dq4irI7KDuwCoYu0wlxns9btQ/HQmXQQltdr8XGVHRuPzwyZpBY//8lNQaCJEhrC8 GdzA== X-Gm-Message-State: AOJu0YwVRVqCTQhxOXJjKICHj+t83/J7fWITv4d+jfIDD7MXdnlb/Gvl 3HlR9XjdHI2JFyE8UdfpUUz0KZQRHwg= X-Received: from glider.muc.corp.google.com ([2a00:79e0:9c:201:132e:31bc:8300:d4e1]) (user=glider job=sendgmr) by 2002:a25:ad5a:0:b0:d90:e580:88e5 with SMTP id l26-20020a25ad5a000000b00d90e58088e5mr184178ybe.10.1698679934767; Mon, 30 Oct 2023 08:32:14 -0700 (PDT) Date: Mon, 30 Oct 2023 16:32:09 +0100 Mime-Version: 1.0 X-Mailer: git-send-email 2.42.0.820.g83a721a137-goog Message-ID: <20231030153210.139512-1-glider@google.com> Subject: [PATCH v11 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=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS,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-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Mon, 30 Oct 2023 08:32:22 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1781195020986245551 X-GMAIL-MSGID: 1781195020986245551 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 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/bitmap: add bitmap_{set,get}_value()" (https://lore.kernel.org/lkml/20230720173956.3674987-2-glider@google.com/) v11: - rearrange whitespace as requested by Andy Shevchenko, add Reviewed-by:, update a comment v10: - update comments as requested by Andy Shevchenko 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 | 77 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h index 03644237e1efb..7dd00e2e6d539 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,79 @@ 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 bits located at the @start bit offset within the + * @map memory region. For @nbits = 0 and @nbits > BITS_PER_LONG the return + * value is undefined. + */ +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)); + * + * For @nbits == 0 and @nbits > BITS_PER_LONG no writes are performed. + */ +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 Mon Oct 30 15:32:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Potapenko X-Patchwork-Id: 159789 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp2302890vqb; Mon, 30 Oct 2023 08:32:30 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHczGnsh/aSBHp0PxGCJuJCYKMpuBPWJ0cUsySysyf8uoefH7fCO0VPZGOUmOsuQbhMN918 X-Received: by 2002:a05:6a00:16c7:b0:6be:bc50:b5e6 with SMTP id l7-20020a056a0016c700b006bebc50b5e6mr8998159pfc.0.1698679950656; Mon, 30 Oct 2023 08:32:30 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698679950; cv=none; d=google.com; s=arc-20160816; b=Fmy49Y++vC08mcNiJ7zFh6SBCibaGD+nO4s8Apgcv5++ZSG9J8dnTvMQAm5v3JR86h ntDiVO+ftopa4vJkhMngpogw5KoOBJbTQoGAaYW4B5OvOX6B4vnwEcJ6khuBsXWbjOgc Zc5BYL44YAmXtVyUNWldijAofWcK3y85++r1iPO1vQ9UHB1P+N6mctISFR0OnaybjVT+ kBBraZMZePy5jDhwr9Y3ZxU6yl2UEXMcfXRNNJC0cuPKhVhNfJEYFkOj/Sl8NPsKjU+j G966SHw6HyWGb8EvgtAA54JNTT2AD9BnIOTbR4QWbu+nhJmcM/5xeO/U2s/+kBtPRcJ5 kemA== 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=00X+K7tQIGqj3wkduJfRhjiel20GeeDllIRy1nuGhjg=; fh=bwsiIJU4ZySHCYgdbJrawkDYkx7XsqbTjYxIEnch01E=; b=NL0g2l32sp71YCasrLzrJhPhbasElYV0agJoCJtYIxNfnZsbi+dB73U2xYWshkeuzR lCRCdw++SXQc2QaeAgakt3uOmZ1tvxkaJQ4Tj/kKNhA6y00Fc3xCQbV7XlmbcGweBexc TAjDdYHTQ6k7Hn0EB3mocfeK+Q66Pbn2O295Z+TE0vyEXrBee93+zFsGIni7f7VPS9LT 3DqgkLbFGGqaM9Rsjg3SsF5V+DINDanYmBiHhXfZ5vl8D8ki2OhZCkJIqKnDIOpbQcsg kGVJlNk3Wh1cAnkiD/f6bOTfDHoBg17q2KjJaXjocaU4T+hk/UpK2fHYEKX4XzFgSw4W N8Rw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=ziLMb7Nq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 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 snail.vger.email (snail.vger.email. [2620:137:e000::3:7]) by mx.google.com with ESMTPS id i14-20020aa796ee000000b006c0f03b2466si2408831pfq.53.2023.10.30.08.32.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Oct 2023 08:32:30 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=ziLMb7Nq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 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 snail.vger.email (Postfix) with ESMTP id 596A380C5903; Mon, 30 Oct 2023 08:32:29 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233665AbjJ3PcZ (ORCPT + 32 others); Mon, 30 Oct 2023 11:32:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46408 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231395AbjJ3PcW (ORCPT ); Mon, 30 Oct 2023 11:32:22 -0400 Received: from mail-wr1-x44a.google.com (mail-wr1-x44a.google.com [IPv6:2a00:1450:4864:20::44a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 932FDB3 for ; Mon, 30 Oct 2023 08:32:19 -0700 (PDT) Received: by mail-wr1-x44a.google.com with SMTP id ffacd0b85a97d-32f7cfab43eso908660f8f.1 for ; Mon, 30 Oct 2023 08:32:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1698679938; x=1699284738; 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=00X+K7tQIGqj3wkduJfRhjiel20GeeDllIRy1nuGhjg=; b=ziLMb7NqyHBpyuw8aQALJlx65wX+MxNaVVvfSbo09e8VF2CVQsue50SmqaGr8caGC5 eB54pC1PSU9RwQ2fFBCd9U0Lq5eRCP+yQI/AJ6NAAbwhq3UCiFWl7FvhaxZALtXIs8Z5 znkaeo2IvagpiG03CS/3eOxFpn6W+UGr6xm0G2U02tBzi54ecJTGkO/Vqh4p6dQNCYF3 21+M59SVGNO1cGQ8F0Mw45EyZvg6dVxzzgE4vXaaRLkKf4iHC/unAyzQNEV/t5jHpUmK YF9w9X/OsvJAQUJS/oJXmpZo3WISr+pkVdm5N+GJOqS0xCMQ1fE6Kxc4hXKG6aXphD9c ybnw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698679938; x=1699284738; 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=00X+K7tQIGqj3wkduJfRhjiel20GeeDllIRy1nuGhjg=; b=KS3Hms4xCA7l7QnJP0/2IuOQ2MkE24kvK7UboeINCiJgZziO01OhOhyZcHyq3DnOiz I/ld41wDR+iC4JP3+ztUDDoeRJ+ZAOgcN7MSy/TX0lWJ1EsAZEYV0uJegLdL3z55Ehdl VTezlRMUwPno6OMMpNIiYpTBLsEx22g5ttMQAIPCAv3s8FoUZjigerXBl0reYDDdocCL BSp1EOqrCBuc4RBdwqI8okKmJlXzJ3nbxXa1wupuMu7TT3fEPKBk4iHfSh0LlYPY/JL5 okZqkZZFzhB77LkRzJJuKo80uNtcFkPgbYCVVz1SM0mmP16MWfDta5n0NALok7OVAHYO 23xQ== X-Gm-Message-State: AOJu0YwdtrsME+0RJmXVyu0fyIw+OIlRwm9ni9soSnfBoie1ruTsycX7 ejcj+BWwLdy6Rr9mmqQyWZfWukEokjA= X-Received: from glider.muc.corp.google.com ([2a00:79e0:9c:201:132e:31bc:8300:d4e1]) (user=glider job=sendgmr) by 2002:adf:f94a:0:b0:32d:a117:fda6 with SMTP id q10-20020adff94a000000b0032da117fda6mr82163wrr.4.1698679937742; Mon, 30 Oct 2023 08:32:17 -0700 (PDT) Date: Mon, 30 Oct 2023 16:32:10 +0100 In-Reply-To: <20231030153210.139512-1-glider@google.com> Mime-Version: 1.0 References: <20231030153210.139512-1-glider@google.com> X-Mailer: git-send-email 2.42.0.820.g83a721a137-goog Message-ID: <20231030153210.139512-2-glider@google.com> Subject: [PATCH v11 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=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS,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-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Mon, 30 Oct 2023 08:32:29 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1781195028055327452 X-GMAIL-MSGID: 1781195028055327452 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();