From patchwork Wed Nov 14 22:49:18 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Keith Busch X-Patchwork-Id: 10683291 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1787D14DB for ; Wed, 14 Nov 2018 22:53:16 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0AB102BF63 for ; Wed, 14 Nov 2018 22:53:16 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id F37792BF77; Wed, 14 Nov 2018 22:53:15 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 704482BF6C for ; Wed, 14 Nov 2018 22:53:15 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8C0276B0266; Wed, 14 Nov 2018 17:53:06 -0500 (EST) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 859BD6B026D; Wed, 14 Nov 2018 17:53:06 -0500 (EST) X-Original-To: int-list-linux-mm@kvack.org X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 546B16B026A; Wed, 14 Nov 2018 17:53:06 -0500 (EST) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-pl1-f198.google.com (mail-pl1-f198.google.com [209.85.214.198]) by kanga.kvack.org (Postfix) with ESMTP id 099706B0266 for ; Wed, 14 Nov 2018 17:53:06 -0500 (EST) Received: by mail-pl1-f198.google.com with SMTP id t5-v6so13128425plo.2 for ; Wed, 14 Nov 2018 14:53:06 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-original-authentication-results:x-gm-message-state:from:to:cc :subject:date:message-id:in-reply-to:references; bh=+ITiI+DOKQv2M/zI2RuqPItw78++KPuAgzud/7mnErc=; b=ond62zCUAJRacdj2/01nKiXjT2uRyiCiSK3p5lFuubgShkDslAqgr5sv/NH7t3r1fs I3HWStzuZihM79ZU2I7o3YmYUwSNDGGqMfXJXRHaix86rRQyNLagsZriuZkgCJlHreCd DrtzYXmdHYMzaEhMOap81MId77Xvwxt2v4Y98vbdbEs1sGinHX3ob/E13eiNi69SQyXG WfwIf3aQcLvj+bffo8C2IfncyzlJjiKloH8XAUhEt4rrOKLw73AsqkjKKVr2xM/yfd8J cxxP0g4iZ7Eoc4An1Hlti4OPyNUTEq+kZuivQpYSSyMi8MowHNgpR8fRde2FXf4sK2cw Lw2A== X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of keith.busch@intel.com designates 134.134.136.100 as permitted sender) smtp.mailfrom=keith.busch@intel.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com X-Gm-Message-State: AGRZ1gIlOtbfi7Uj4NM0GuajhZtsZcnthHPmDfkLAJ+irZ6Vrr4pAaT1 mMYFdzx1W+aor0weJEN7Csi0wnvCLc9VrGBzbiGzzij+l1YAazlA2rlq5t/+Js9fDIacQlYwj5e L0xNnQqIHMLgPULWX6R3Naex9+tZWOSXIWr8Dr3MfmfN/LP0jM0L85deon7y64xvIrQ== X-Received: by 2002:a17:902:8507:: with SMTP id bj7-v6mr3695681plb.99.1542235985694; Wed, 14 Nov 2018 14:53:05 -0800 (PST) X-Google-Smtp-Source: AJdET5fbaRglYQuENMo19k4/Ib8INwe2M0c/BCLy9JRdSZeckMKk5WRRGgRMSLobdtL1I3X2Pha8 X-Received: by 2002:a17:902:8507:: with SMTP id bj7-v6mr3695640plb.99.1542235984789; Wed, 14 Nov 2018 14:53:04 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1542235984; cv=none; d=google.com; s=arc-20160816; b=w4+pMl1oQZibI9Km+lFdXcRd/OeJFRVE2ZOVlo076AGKQT3B8O4NnEHbN9ZHb5pmWs 73nbj76lSuYKXOno1nBN2djDT+9s0Gz2R7VkKtXmFDELw6kmin5Rp9ebsZqMfOdUt+b5 VL93Jw2rzNOOsn5CeMNhLEZwBLgMfqDZun3Q7McUo7VPuV5mqR9ipzKFr6CxbNfimW0g nX6Lp2wQaqWRF5QK2JvbY1E3k8ZXQd+hcFzfmbwozEGe2RX2QD8VayVWdSuVop6ZgWWa A6Mh5iC72Ob7zBRJ7Zu5DQHYJ+Ob2vShOTstqPekXZIYRG3Vbp1CulR60FEjkSatDeAf nuHw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=references:in-reply-to:message-id:date:subject:cc:to:from; bh=+ITiI+DOKQv2M/zI2RuqPItw78++KPuAgzud/7mnErc=; b=gcn1KYASX4ROQuiRMB5avP66oXH1CSLMcHkcQGdjj5thDLe3Nyw77EFYfqxCJq0LB1 vtENGvGlcCIswIQFX+Q+xvJFbekzyaH9eaHn7iBDAURE6337QsXhJzeDhjw4iH+aygLv 9FDptfCmWPoo44EGucQvJqI0jP+v8VC7IZLLlzw0inXwvCRtvusOMo3TzYw1DlhMZ47l l/+latkYoepeTmWyXgfrza6DhBG8lxhl3pQpZEF1yYObDuFPuz/1yPJ9PZIdyIdyGMm4 vUgB3EYrIf5+3GKRCVU6+EOfaSyHm3C8lQ0Tb+AfG08V4LO9i7pZuyYomAzCfnlYBATe ZCUw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of keith.busch@intel.com designates 134.134.136.100 as permitted sender) smtp.mailfrom=keith.busch@intel.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from mga07.intel.com (mga07.intel.com. [134.134.136.100]) by mx.google.com with ESMTPS id d10-v6si26779897pla.207.2018.11.14.14.53.04 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 14 Nov 2018 14:53:04 -0800 (PST) Received-SPF: pass (google.com: domain of keith.busch@intel.com designates 134.134.136.100 as permitted sender) client-ip=134.134.136.100; Authentication-Results: mx.google.com; spf=pass (google.com: domain of keith.busch@intel.com designates 134.134.136.100 as permitted sender) smtp.mailfrom=keith.busch@intel.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Nov 2018 14:53:04 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,234,1539673200"; d="scan'208";a="106314891" Received: from unknown (HELO localhost.lm.intel.com) ([10.232.112.69]) by fmsmga004.fm.intel.com with ESMTP; 14 Nov 2018 14:53:04 -0800 From: Keith Busch To: linux-kernel@vger.kernel.org, linux-acpi@vger.kernel.org, linux-mm@kvack.org Cc: Greg Kroah-Hartman , Rafael Wysocki , Dave Hansen , Dan Williams , Keith Busch Subject: [PATCH 5/7] doc/vm: New documentation for memory cache Date: Wed, 14 Nov 2018 15:49:18 -0700 Message-Id: <20181114224921.12123-6-keith.busch@intel.com> X-Mailer: git-send-email 2.13.6 In-Reply-To: <20181114224921.12123-2-keith.busch@intel.com> References: <20181114224921.12123-2-keith.busch@intel.com> X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: X-Virus-Scanned: ClamAV using ClamSMTP Platforms may provide system memory that contains side caches to help spped up access. These memory caches are part of a memory node and the cache attributes are exported by the kernel. Add new documentation providing a brief overview of system memory side caches and the kernel provided attributes for application optimization. Signed-off-by: Keith Busch --- Documentation/vm/numacache.rst | 76 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Documentation/vm/numacache.rst diff --git a/Documentation/vm/numacache.rst b/Documentation/vm/numacache.rst new file mode 100644 index 000000000000..e79c801b7e3b --- /dev/null +++ b/Documentation/vm/numacache.rst @@ -0,0 +1,76 @@ +.. _numacache: + +========== +NUMA Cache +========== + +System memory may be constructed in a hierarchy of various performing +characteristics in order to provide large address space of slower +performing memory cached by a smaller size of higher performing +memory. The system physical addresses that software is aware of see +is provided by the last memory level in the hierarchy, while higher +performing memory transparently provides caching to slower levels. + +The term "far memory" is used to denote the last level memory in the +hierarchy. Each increasing cache level provides higher performing CPU +access, and the term "near memory" represents the highest level cache +provided by the system. This number is different than CPU caches where +the cache level (ex: L1, L2, L3) uses a CPU centric view with each level +being lower performing and closer to system memory. The memory cache +level is centric to the last level memory, so the higher numbered cache +level denotes memory nearer to the CPU, and further from far memory. + +The memory side caches are not directly addressable by software. When +software accesses a system address, the system will return it from the +near memory cache if it is present. If it is not present, the system +accesses the next level of memory until there is either a hit in that +cache level, or it reaches far memory. + +In order to maximize the performance out of such a setup, software may +wish to query the memory cache attributes. If the system provides a way +to query this information, for example with ACPI HMAT (Heterogeneous +Memory Attribute Table)[1], the kernel will append these attributes to +the NUMA node that provides the memory. + +When the kernel first registers a memory cache with a node, the kernel +will create the following directory:: + + /sys/devices/system/node/nodeX/cache/ + +If that directory is not present, then either the memory does not have +a side cache, or that information is not provided to the kernel. + +The attributes for each level of cache is provided under its cache +level index:: + + /sys/devices/system/node/nodeX/cache/indexA/ + /sys/devices/system/node/nodeX/cache/indexB/ + /sys/devices/system/node/nodeX/cache/indexC/ + +Each cache level's directory provides its attributes. For example, +the following is a single cache level and the attributes available for +software to query:: + + # tree sys/devices/system/node/node0/cache/ + /sys/devices/system/node/node0/cache/ + |-- index1 + | |-- associativity + | |-- level + | |-- line_size + | |-- size + | `-- write_policy + +The cache "associativity" will be 0 if it is a direct-mapped cache, and +non-zero for any other indexed based, multi-way associativity. + +The "level" is the distance from the far memory, and matches the number +appended to its "index" directory. + +The "line_size" is the number of bytes accessed on a cache miss. + +The "size" is the number of bytes provided by this cache level. + +The "write_policy" will be 0 for write-back, and non-zero for +write-through caching. + +[1] https://www.uefi.org/sites/default/files/resources/ACPI_6_2.pdf