Received: by 2002:a25:ad19:0:0:0:0:0 with SMTP id y25csp206358ybi; Fri, 26 Jul 2019 08:26:35 -0700 (PDT) X-Google-Smtp-Source: APXvYqwEbRN31k6f5GW5/e465Jndxgpk5y8bZXKd7Qzh+FKD6O04lpoFvwjNr1dgtSiQmd3nzSi0 X-Received: by 2002:a17:90a:bb8a:: with SMTP id v10mr99871522pjr.78.1564154795632; Fri, 26 Jul 2019 08:26:35 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1564154795; cv=none; d=google.com; s=arc-20160816; b=ZRcXhxE6Fk3wGdhHbAcGCeruooyGFwB2/75xCsyDryAUyS0JkcnfXp0rKr5WNO1ZkD HqsFfmQWFpEmw7eO3N1tfGzH2aBeZkhnrUX95/kjd09+tKvynNh+ZZ0Cp5+yqw1wOnRY 5XeqmSEt2jsFhIIPpG7nQJlJ0dhKzbEl9Jb5clVnJFpm5BBCdEtubi8PWOvxiKj+H4LH w7BP6Y9PH8mUx2Ym1c8DwgfmKIa4l2GatGL51RHM76LZ/QFY3FCTyrKqDhoKO/E1jZgr iZA4iMXMT/pzS6hFrOBAGwUxS8R111mcp7t/lVonROC+k4QW4LN0wAVWuYRUsTyz1ka/ rzFw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=dWQZR/3W1JJGAqPUD7hTWyfWfaLoNTQhqklPLc/rCo0=; b=l0afZY34fXtv/zSyo2bFW5uFuplkNEgwFbrjJNji/WZxgoJVgi6OxEUdwTiPc3iYVY dtjaw2EbzrU3Cmkrbedfm4U0e92cTUUQ833DxcPI0zglC7ZqusyGgwpDWyQSgGG/zMjm 3jfW0iVncWXdl6bOEJ6WpKwEVt/38nd0+ExUHIeLg5tcefl49JPzgk/LuCfbSS5Pzj3E Uiscp0ZCIlItEd+wVbQ21Ou7rLZmEojhJdwdbzp6cva/45VEEICI1wUbV71ZpCOVaX1D p1lOML2frwKZaSZlU7yvEE1swCqvR/24TCznWKAgZl90rBDjO5Hge4Sw9YBLNGcQR4iG aFOg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@joelfernandes.org header.s=google header.b=NSm723gH; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id a5si20082095pgw.454.2019.07.26.08.26.20; Fri, 26 Jul 2019 08:26:35 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@joelfernandes.org header.s=google header.b=NSm723gH; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728432AbfGZPXe (ORCPT + 99 others); Fri, 26 Jul 2019 11:23:34 -0400 Received: from mail-pl1-f193.google.com ([209.85.214.193]:46053 "EHLO mail-pl1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728416AbfGZPXd (ORCPT ); Fri, 26 Jul 2019 11:23:33 -0400 Received: by mail-pl1-f193.google.com with SMTP id y8so24901406plr.12 for ; Fri, 26 Jul 2019 08:23:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=joelfernandes.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=dWQZR/3W1JJGAqPUD7hTWyfWfaLoNTQhqklPLc/rCo0=; b=NSm723gHApWanD6yeW4J2Hod3LusoD9q5rDYeMMOfmnvzy1V6IW8Ik70kYPIywWp+5 ePTv11kUJPhco3rtrxGscl1Xvn/9LGCfMjCA63hEQGhn0+RLeCWphNUjv25+mG/EUvI5 IipB8N+66gykX0zBQeBiqZbzJqprH2vYSF24M= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=dWQZR/3W1JJGAqPUD7hTWyfWfaLoNTQhqklPLc/rCo0=; b=sCPPa+XTX7Q3jFTYKc4bdl8W4VJrC3ZeDI7i15Y9ntR/8QJ5ra0ZcHeX7HueTDE9bJ cmhRbe4huaIEOtjWWohBw9zqK6TA3LxK0p2irHF103Bk+6S4bzkZ60yE1XhhgZwOm84j 7LeAyTLITpuKMeZ/dpZukTWTQCR4vAeRk6vGL6jwP3NhAbi5qg5N3qEgQm5U5Rj7wohf JjaNuzHtXLT+hwHfF1XwH199yOCSeHRmIXJ7df8Zbt20vm0MaUyE10QPXDt4lYbFeP4q qbguxO1uAhiurDR3tbj4kBH8wXOG3X8Gg0A3sWuB81ciNxW00FUdbUPekiPOLCnqE99j ziZw== X-Gm-Message-State: APjAAAVHCu//GpI/RJGkWsdQNgewHkfP4AjOkccoSWuL3vEl+u8biSAg 70QlUw/a/dW8L4rNG+l1M8XsLw3R X-Received: by 2002:a17:902:be03:: with SMTP id r3mr97943466pls.156.1564154612178; Fri, 26 Jul 2019 08:23:32 -0700 (PDT) Received: from joelaf.cam.corp.google.com ([2620:15c:6:12:9c46:e0da:efbf:69cc]) by smtp.gmail.com with ESMTPSA id w132sm55268640pfd.78.2019.07.26.08.23.28 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Fri, 26 Jul 2019 08:23:31 -0700 (PDT) From: "Joel Fernandes (Google)" To: linux-kernel@vger.kernel.org Cc: "Joel Fernandes (Google)" , Alexey Dobriyan , Andrew Morton , Brendan Gregg , Christian Hansen , dancol@google.com, fmayer@google.com, joaodias@google.com, joelaf@google.com, Jonathan Corbet , Kees Cook , kernel-team@android.com, linux-api@vger.kernel.org, linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org, Michal Hocko , Mike Rapoport , minchan@kernel.org, namhyung@google.com, Roman Gushchin , Stephen Rothwell , surenb@google.com, tkjos@google.com, Vladimir Davydov , Vlastimil Babka , wvw@google.com Subject: [PATCH v3 2/2] doc: Update documentation for page_idle virtual address indexing Date: Fri, 26 Jul 2019 11:23:19 -0400 Message-Id: <20190726152319.134152-2-joel@joelfernandes.org> X-Mailer: git-send-email 2.22.0.709.g102302147b-goog In-Reply-To: <20190726152319.134152-1-joel@joelfernandes.org> References: <20190726152319.134152-1-joel@joelfernandes.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This patch updates the documentation with the new page_idle tracking feature which uses virtual address indexing. Signed-off-by: Joel Fernandes (Google) --- .../admin-guide/mm/idle_page_tracking.rst | 43 ++++++++++++++++--- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/Documentation/admin-guide/mm/idle_page_tracking.rst b/Documentation/admin-guide/mm/idle_page_tracking.rst index df9394fb39c2..1eeac78c94a7 100644 --- a/Documentation/admin-guide/mm/idle_page_tracking.rst +++ b/Documentation/admin-guide/mm/idle_page_tracking.rst @@ -19,10 +19,14 @@ It is enabled by CONFIG_IDLE_PAGE_TRACKING=y. User API ======== +There are 2 ways to access the idle page tracking API. One uses physical +address indexing, another uses a simpler virtual address indexing scheme. -The idle page tracking API is located at ``/sys/kernel/mm/page_idle``. -Currently, it consists of the only read-write file, -``/sys/kernel/mm/page_idle/bitmap``. +Physical address indexing +------------------------- +The idle page tracking API for physical address indexing using page frame +numbers (PFN) is located at ``/sys/kernel/mm/page_idle``. Currently, it +consists of the only read-write file, ``/sys/kernel/mm/page_idle/bitmap``. The file implements a bitmap where each bit corresponds to a memory page. The bitmap is represented by an array of 8-byte integers, and the page at PFN #i is @@ -74,6 +78,31 @@ See :ref:`Documentation/admin-guide/mm/pagemap.rst ` for more information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``. +Virtual address indexing +------------------------ +The idle page tracking API for virtual address indexing using virtual page +frame numbers (VFN) is located at ``/proc//page_idle``. It is a bitmap +that follows the same semantics as ``/sys/kernel/mm/page_idle/bitmap`` +except that it uses virtual instead of physical frame numbers. + +This idle page tracking API does not need deal with PFN so it does not require +prior lookups of ``pagemap`` in order to find if page is idle or not. This is +an advantage on some systems where looking up PFN is considered a security +issue. Also in some cases, this interface could be slightly more reliable to +use than physical address indexing, since in physical address indexing, address +space changes can occur between reading the ``pagemap`` and reading the +``bitmap``, while in virtual address indexing, the process's ``mmap_sem`` is +held for the duration of the access. + +To estimate the amount of pages that are not used by a workload one should: + + 1. Mark all the workload's pages as idle by setting corresponding bits in + ``/proc//page_idle``. + + 2. Wait until the workload accesses its working set. + + 3. Read ``/proc//page_idle`` and count the number of bits set. + .. _impl_details: Implementation Details @@ -99,10 +128,10 @@ When a dirty page is written to swap or disk as a result of memory reclaim or exceeding the dirty memory limit, it is not marked referenced. The idle memory tracking feature adds a new page flag, the Idle flag. This flag -is set manually, by writing to ``/sys/kernel/mm/page_idle/bitmap`` (see the -:ref:`User API ` -section), and cleared automatically whenever a page is referenced as defined -above. +is set manually, by writing to ``/sys/kernel/mm/page_idle/bitmap`` for physical +addressing or by writing to ``/proc//page_idle`` for virtual +addressing (see the :ref:`User API ` section), and cleared +automatically whenever a page is referenced as defined above. When a page is marked idle, the Accessed bit must be cleared in all PTEs it is mapped to, otherwise we will not be able to detect accesses to the page coming -- 2.22.0.709.g102302147b-goog