From patchwork Wed Apr 20 11:19:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rebecca Mckeever X-Patchwork-Id: 12820081 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9B92AC433EF for ; Wed, 20 Apr 2022 11:19:21 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 060856B0073; Wed, 20 Apr 2022 07:19:21 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 011376B0074; Wed, 20 Apr 2022 07:19:20 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id DF3476B0078; Wed, 20 Apr 2022 07:19:20 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0002.hostedemail.com [216.40.44.2]) by kanga.kvack.org (Postfix) with ESMTP id D174A6B0073 for ; Wed, 20 Apr 2022 07:19:20 -0400 (EDT) Received: from smtpin30.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay04.hostedemail.com (Postfix) with ESMTP id 669CEA32BB for ; Wed, 20 Apr 2022 11:19:20 +0000 (UTC) X-FDA: 79377011280.30.8442961 Received: from mail-oi1-f193.google.com (mail-oi1-f193.google.com [209.85.167.193]) by imf24.hostedemail.com (Postfix) with ESMTP id B804A180022 for ; Wed, 20 Apr 2022 11:19:18 +0000 (UTC) Received: by mail-oi1-f193.google.com with SMTP id r8so1648497oib.5 for ; Wed, 20 Apr 2022 04:19:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ocpsacXCMhu5GBT0i/LaXz+wmK5Kqsy/4v93G9iC2Rc=; b=mmplh0H/itlMHz2vLr1LN5tpZ4/fUG5mT1vmfD1oSsoCfI7cESf3kCCDptnBJXg7Mx loOp9QJykorv2QlNs1AOCAwtQ+/LnPF1D1H1JnnlOEzstsZkU4N/rS5pI6U4zK0D42VE e9jHrtKUBHBYe0pgX0M0RU//vwX8tgxU3p+bijtyizTTjshlC5OFGmiDgR1pETSH24/n B1dw7JJxMQgQP64KasBCOLD1DAgHesgfFeKM37Bw0YvNHSEHBDCId2w8YHwcU+rWhNCR UUqSTFgXVG6uaKQfmPi7rMdQk/NCIFcSMWzeugIZ6fIBdyl3fgU4utt3iGuS9w8YH0TN uIWQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ocpsacXCMhu5GBT0i/LaXz+wmK5Kqsy/4v93G9iC2Rc=; b=oVg6VFlyV6fRTp3jHwNiwKcuRmjKnvugBALe+phxojVDD9iaesLInzHH8aY/XnRr5J O9ghn7d81X1V8EDBry4RoRV79mYvXCAhNeB8e/ep6aGt63l6bbcgCO6hg8efK4gXSJxm RkRW7R33Ue+gZCF2CsRvT6i260dSBGU1xA/Uuomqh0Wuv6uxPeScp9LObg4Elp2a6RyD 2I0mqu/w3iWYw8rpOTnLxKSBoNZohv8weAWccgPTPRGNF2YWkCmQQwxEZp1s5czqsibd TvcC49HHuMp+rO14WJwn6zH0XbgoOjWD1UZoWzGwYKSOf4uGzEkEtwFwkJK2q+5s+FV0 sP6A== X-Gm-Message-State: AOAM5324ahSNV2M588PpwFXcSJkBa3uYrt/RRt0g/JPaXyEozo73aQhH 4tECoXnTb4rroxTwY3qxfdk= X-Google-Smtp-Source: ABdhPJzCLioSonUcKlvI1uTh9yYyuPILIAJL12KvTLTjIslEPEY32uLdlGClfc6dNR5E/EQZpzKwEw== X-Received: by 2002:a05:6808:1b0a:b0:2fa:6fdd:e2ee with SMTP id bx10-20020a0568081b0a00b002fa6fdde2eemr1315310oib.237.1650453559240; Wed, 20 Apr 2022 04:19:19 -0700 (PDT) Received: from bertie (072-190-140-117.res.spectrum.com. [72.190.140.117]) by smtp.gmail.com with ESMTPSA id 5-20020a9d0105000000b005fbe5093eb0sm6374070otu.54.2022.04.20.04.19.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Apr 2022 04:19:18 -0700 (PDT) From: Rebecca Mckeever To: outreachy@lists.linux.dev Cc: Mike Rapoport , linux-mm@kvack.org, linux-kernel@vger.kernel.org, David Hildenbrand , Rebecca Mckeever Subject: [PATCH 2/3] memblock tests: update style of comments for memblock_reserve_*() functions Date: Wed, 20 Apr 2022 06:19:01 -0500 Message-Id: <6f385ad37eeb81331f9556fdddeced80ae32bded.1650452552.git.remckee0@gmail.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: References: MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: B804A180022 X-Stat-Signature: d3nx1btjr6u89rbkyganipzw34c1oija Authentication-Results: imf24.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b="mmplh0H/"; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf24.hostedemail.com: domain of remckee0@gmail.com designates 209.85.167.193 as permitted sender) smtp.mailfrom=remckee0@gmail.com X-HE-Tag: 1650453558-479625 X-Bogosity: Ham, tests=bogofilter, spamicity=0.085990, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Update comments in memblock_reserve_*() functions to match the style used in tests/alloc_*.c by rewording to make the expected outcome more apparent and, if more than one memblock is involved, adding a visual of the memory blocks. Signed-off-by: Rebecca Mckeever Reviewed-by: David Hildenbrand --- tools/testing/memblock/tests/basic_api.c | 70 +++++++++++++++++------- 1 file changed, 51 insertions(+), 19 deletions(-) diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c index cdf112d25343..834d8705ff8a 100644 --- a/tools/testing/memblock/tests/basic_api.c +++ b/tools/testing/memblock/tests/basic_api.c @@ -306,8 +306,8 @@ static int memblock_add_checks(void) /* * A simple test that marks a memory block of a specified base address * and size as reserved and to the collection of reserved memory regions - * (memblock.reserved). It checks if a new entry was created and if region - * counter and total memory size were correctly updated. + * (memblock.reserved). Expect to create a new entry. The region counter + * and total memory size are updated. */ static int memblock_reserve_simple_check(void) { @@ -330,10 +330,15 @@ static int memblock_reserve_simple_check(void) } /* - * A test that tries to mark two memory blocks that don't overlap as reserved - * and checks if two entries were correctly added to the collection of reserved - * memory regions (memblock.reserved) and if this change was reflected in - * memblock.reserved's total size and region counter. + * A test that tries to mark two memory blocks that don't overlap as reserved: + * + * | +--+ +----------------+ | + * | |r1| | r2 | | + * +--------+--+------+----------------+--+ + * + * Expect to add two entries to the collection of reserved memory regions + * (memblock.reserved). The total size and region counter for + * memblock.reserved are updated. */ static int memblock_reserve_disjoint_check(void) { @@ -370,11 +375,20 @@ static int memblock_reserve_disjoint_check(void) /* * A test that tries to mark two memory blocks as reserved, where the * second one overlaps with the beginning of the first (that is - * r1.base < r2.base + r2.size). - * It checks if two entries are merged into one region that starts at r2.base - * and has size of two regions minus their intersection. The test also verifies - * that memblock can still see only one entry and has a correct total size of - * the reserved memory. + * r1.base < r2.base + r2.size): + * + * | +--------------+--+--------------+ | + * | | r2 | | r1 | | + * +--+--------------+--+--------------+--+ + * ^ ^ + * | | + * | r1.base + * | + * r2.base + * + * Expect to merge two entries into one region that starts at r2.base and + * has size of two regions minus their intersection. The total size of the + * reserved memory is updated, and the region counter is not updated. */ static int memblock_reserve_overlap_top_check(void) { @@ -411,10 +425,19 @@ static int memblock_reserve_overlap_top_check(void) * A test that tries to mark two memory blocks as reserved, where the * second one overlaps with the end of the first entry (that is * r2.base < r1.base + r1.size). - * It checks if two entries are merged into one region that starts at r1.base - * and has size of two regions minus their intersection. It verifies that - * memblock can still see only one entry and has a correct total size of the - * reserved memory. + * + * | +--------------+--+--------------+ | + * | | r1 | | r2 | | + * +--+--------------+--+--------------+--+ + * ^ ^ + * | | + * | r2.base + * | + * r1.base + * + * Expect to merge two entries into one region that starts at r1.base and + * has size of two regions minus their intersection. The total size of the + * reserved memory is updated, and the region counter is not updated. */ static int memblock_reserve_overlap_bottom_check(void) { @@ -451,9 +474,18 @@ static int memblock_reserve_overlap_bottom_check(void) * A test that tries to mark two memory blocks as reserved, where the second * one is within the range of the first entry (that is * (r1.base < r2.base) && (r2.base + r2.size < r1.base + r1.size)). - * It checks if two entries are merged into one region that stays the - * same. The counter and total size of available memory are expected to not be - * updated. + * + * | +-----+--+---------------------------| + * | | |r2| r1 | + * +-+-----+--+---------------------------+ + * ^ ^ + * | | + * | r2.base + * | + * r1.base + * + * Expect to merge two entries into one region that stays the same. The + * counter and total size of available memory are not updated. */ static int memblock_reserve_within_check(void) { @@ -485,7 +517,7 @@ static int memblock_reserve_within_check(void) /* * A simple test that tries to reserve the same memory block twice. - * The region counter and total size of reserved memory are expected to not + * Expect the region counter and total size of reserved memory to not * be updated. */ static int memblock_reserve_twice_check(void)