From patchwork Wed Apr 20 11:19:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rebecca Mckeever X-Patchwork-Id: 12820080 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 75D4AC433F5 for ; Wed, 20 Apr 2022 11:19:18 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id EB91C6B0075; Wed, 20 Apr 2022 07:19:17 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id E43836B0074; Wed, 20 Apr 2022 07:19:17 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id CE3A66B0075; Wed, 20 Apr 2022 07:19:17 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (relay.hostedemail.com [64.99.140.25]) by kanga.kvack.org (Postfix) with ESMTP id BEB706B0073 for ; Wed, 20 Apr 2022 07:19:17 -0400 (EDT) Received: from smtpin11.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay12.hostedemail.com (Postfix) with ESMTP id 9DF24122869 for ; Wed, 20 Apr 2022 11:19:17 +0000 (UTC) X-FDA: 79377011154.11.D9295FE Received: from mail-oi1-f196.google.com (mail-oi1-f196.google.com [209.85.167.196]) by imf19.hostedemail.com (Postfix) with ESMTP id 7CCCB1A000E for ; Wed, 20 Apr 2022 11:19:15 +0000 (UTC) Received: by mail-oi1-f196.google.com with SMTP id z8so1664297oix.3 for ; Wed, 20 Apr 2022 04:19:16 -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=gDJLRabuQJj3syOFUDJSDmCnEvak7iaR6PEx0BgfcbE=; b=KH29lOPOenBJ5J2hq2vFGKN+J/H5njXUX7QRIivIVMGUpxMMYOOWlPwYm9+J/9SRML lYGLaLfQ6L/WIgIgENJblT/aPveWE6WyH6xFG1QpBM5RRn/e6aXI4uM0BgTfbOhimyHT /Pp95UtvXJ+r0uD5Vn+a0KqaH6c92NnembOH+dveEGb61PEUvAsHmdMqqBs8hE20U8e8 Z/jtnqq3pr4668O8pMWF4JashWesSs9L80PXTO6V+Olt5QVVlIQ37tlD4TeZFeN2pALu 3rSBC3l2zSOZG2Bg0eTU3wqAhUEUHN/T9GG4rJHE6JEOnek0fvK0IbJzlKQkMTifNTI7 T8dg== 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=gDJLRabuQJj3syOFUDJSDmCnEvak7iaR6PEx0BgfcbE=; b=2XzMwqaj85JVCBZZkwY2e3Lu84UljMKIq18SX21hT6DN58hEtuXvAH7Z2sPPi5uP61 Vu+3EfYr4Wr9EjjFDMZWNfIFRzZHYR5Aa7VJdgf6abhW3CH0nlJSekuR/aXbdITzN6bY rbsVHpUE6MEOimpXrRGSDY0zJBGK5AjYq07bvMcHPa7jbJYLdOiWpCw3imEyN68vdJ2z VxSx595kFCSkg4E16GOB85Xkj6ecX1IAn8QbB5CU5VwyruVIMyhp4QTQNM/hpYpjdpxe qlRlqtkY6Ewz+bxGwQ0WJW9SrCPHC1I+bYneE4crlpgFSLGWj+3XX0qqKcAEZnoy++/W Pn2g== X-Gm-Message-State: AOAM533hS3WbWjJwfC9DM3kVGDn6zUFQlRDEvX253eNVhnRCIrLmHstc FEvlfh6dRd+tPxQo7DMgPiA= X-Google-Smtp-Source: ABdhPJwaEwD0/ZAaRKhv6NAb6Yvy6whTC/ZCrTYJO+a6+wsufJPu1I83zjDCtkI5oHirQNCaTXTxxw== X-Received: by 2002:a05:6808:1244:b0:322:6925:3f4f with SMTP id o4-20020a056808124400b0032269253f4fmr1402356oiv.39.1650453556416; Wed, 20 Apr 2022 04:19:16 -0700 (PDT) Received: from bertie (072-190-140-117.res.spectrum.com. [72.190.140.117]) by smtp.gmail.com with ESMTPSA id b16-20020a056870471000b000e5caa2b264sm3554224oaq.20.2022.04.20.04.19.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Apr 2022 04:19:16 -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 1/3] memblock tests: update style of comments for memblock_add_*() functions Date: Wed, 20 Apr 2022 06:19:00 -0500 Message-Id: <0004a1a720c5c15ba16cb9f2fb226f57276de2c0.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-Queue-Id: 7CCCB1A000E X-Stat-Signature: 8yaqngwzabpqjx8fy7p9bioirzuu8x1e Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=KH29lOPO; spf=pass (imf19.hostedemail.com: domain of remckee0@gmail.com designates 209.85.167.196 as permitted sender) smtp.mailfrom=remckee0@gmail.com; dmarc=pass (policy=none) header.from=gmail.com X-Rspamd-Server: rspam01 X-HE-Tag: 1650453555-928952 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000053, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Update comments in memblock_add_*() 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 | 75 +++++++++++++++++------- 1 file changed, 54 insertions(+), 21 deletions(-) diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c index fbc1ce160303..cdf112d25343 100644 --- a/tools/testing/memblock/tests/basic_api.c +++ b/tools/testing/memblock/tests/basic_api.c @@ -26,8 +26,8 @@ static int memblock_initialization_check(void) /* * A simple test that adds a memory block of a specified base address * and size to the collection of available memory regions (memblock.memory). - * It checks if a new entry was created and if region counter and total memory - * were correctly updated. + * Expect to create a new entry. The region counter and total memory get + * updated. */ static int memblock_add_simple_check(void) { @@ -55,8 +55,8 @@ static int memblock_add_simple_check(void) /* * A simple test that adds a memory block of a specified base address, size * NUMA node and memory flags to the collection of available memory regions. - * It checks if the new entry, region counter and total memory size have - * expected values. + * Expect to create a new entry. The region counter and total memory get + * updated. */ static int memblock_add_node_simple_check(void) { @@ -87,9 +87,15 @@ static int memblock_add_node_simple_check(void) /* * A test that tries to add two memory blocks that don't overlap with one - * another. It checks if two correctly initialized entries were added to the - * collection of available memory regions (memblock.memory) and if this - * change was reflected in memblock.memory's total size and region counter. + * another: + * + * | +--------+ +--------+ | + * | | r1 | | r2 | | + * +--------+--------+--------+--------+--+ + * + * Expect to add two correctly initialized entries to the collection of + * available memory regions (memblock.memory). The total size and + * region counter fields get updated. */ static int memblock_add_disjoint_check(void) { @@ -125,10 +131,20 @@ static int memblock_add_disjoint_check(void) /* * A test that tries to add two memory blocks, where the second one overlaps - * with the beginning of the first entry (that is r1.base < r2.base + r2.size). - * After this, it checks if two entries are merged into one region that starts - * at r2.base and has size of two regions minus their intersection. It also - * verifies the reported total size of the available memory and region counter. + * with the beginning of the first entry (that is r1.base < r2.base + r2.size): + * + * | +----+----+------------+ | + * | | r|2 | r1 | | + * +----+----+----+------------+----------+ + * ^ ^ + * | | + * | r1.base + * | + * r2.base + * + * Expect to merge the two entries into one region that starts at r2.base + * and has size of two regions minus their intersection. The total size of + * the available memory is updated, and the region counter stays the same. */ static int memblock_add_overlap_top_check(void) { @@ -163,11 +179,20 @@ static int memblock_add_overlap_top_check(void) /* * A test that tries to add two memory blocks, where the second one overlaps - * with the end of the first entry (that is r2.base < r1.base + r1.size). - * After this, 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 available memory. + * with the end of the first entry (that is r2.base < r1.base + r1.size): + * + * | +--+------+----------+ | + * | | | r1 | r2 | | + * +--+--+------+----------+--------------+ + * ^ ^ + * | | + * | r2.base + * | + * r1.base + * + * Expect to merge the two entries into one region that starts at r1.base + * and has size of two regions minus their intersection. The total size of + * the available memory is updated, and the region counter stays the same. */ static int memblock_add_overlap_bottom_check(void) { @@ -203,9 +228,17 @@ static int memblock_add_overlap_bottom_check(void) /* * A test that tries to add two memory blocks, 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.base + r2.size < r1.base + r1.size). + * + * | +-------+--+-----------------------+ + * | | |r2| r1 | + * +---+-------+--+-----------------------+ + * ^ + * | + * 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_add_within_check(void) { @@ -236,8 +269,8 @@ static int memblock_add_within_check(void) } /* - * A simple test that tries to add the same memory block twice. The counter - * and total size of available memory are expected to not be updated. + * A simple test that tries to add the same memory block twice. Expect + * the counter and total size of available memory to not be updated. */ static int memblock_add_twice_check(void) {