Received: by 2002:ab2:b82:0:b0:1f3:401:3cfb with SMTP id 2csp120787lqh; Wed, 27 Mar 2024 17:25:39 -0700 (PDT) X-Forwarded-Encrypted: i=3; AJvYcCUEGUNAwm0DxpcEkgC1M39f2P0HKkfBm/d99lL0rXTVFuUSpzVm71WFkS0wq4cJDzn1Nbts4aeQk0Dc0qVteQCKO39ppaKiy33v61UibA== X-Google-Smtp-Source: AGHT+IFpTYJGbP8cXvqoGBU0+mYJx86ZLMr/MC6ly0DBYq14PSRspWL/7zl97php3ABW/JHUdfpQ X-Received: by 2002:a0c:cb11:0:b0:696:42f7:142e with SMTP id o17-20020a0ccb11000000b0069642f7142emr1116548qvk.47.1711585539675; Wed, 27 Mar 2024 17:25:39 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1711585539; cv=pass; d=google.com; s=arc-20160816; b=swD37aap6Csxb9xgZeg5MP4/PlHRpqqz//MNcc10VUCo3GkD5j/vvh4QiMF38x2NFV qPD6PQ61B8Fay0ev77TTiW26RvVFUuy33jQgxr5nCkj11cqHhPeBMEQz0nSaO4WGTpZs ZDa/r09KiackGy6BKAixZPW3do4Tx1UvdgvMr0sezDAmgX9PJXZ5YfqxcLqzQsXADOaJ bgsFt0tWlO7mKT1zPtHJiFFxECfwaMx7xkFTjjbYj5Y/MAnJkV6Euxux2sqC8hwplTAB JBLZYM1QXps4uvHny5Qcg1guSkUe1CLRYHdVe13LQBxRdTj2RTquUinpKznoTDZDKFmI kDww== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=IK1zZD9GQLiLQlBRFrkRhjEGngByj19LCkee3XOSOjQ=; fh=G1r0sJ0F/0v82zumykPUwC7a5Du5vVkWNEWao5ifD3o=; b=UIppW3tSCPm0Js2WrgO/oWgFCvcx1bDOruLWgRRHcUzJeR7t3jRE2iP2t6dXqE2ORz HkDpxsgRXgvihh0zIk89w3MrE+NdxBDU/Zx3Ho8WGaT1C68Aouwo8l9IGUCJpQyyhjId lvt+pS940EoW6ZNtQqH7Z02RaC7raUnC0YpeHnwYByyISg3kWK+8VFYuJlykS0ASzNkG ZqIHkAEMXiB1JNyC+Ci7q57VQb3hIIlRuJa8EIkisKAncETZ3GOfynZapw/EOzKyOrOx zGlbvKBmfOa78Z6HoqMJB59/Ch1KKiIvCw7O5XlpQ/kFT52rbwZ+lVeYHW5L8kI5FQ5X 03RQ==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b="LCTx/cDC"; arc=pass (i=1 dkim=pass dkdomain=intel.com dmarc=pass fromdomain=linux.intel.com); spf=pass (google.com: domain of linux-kernel+bounces-122227-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-122227-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Return-Path: Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id k11-20020a0cf28b000000b0069673f5e467si334263qvl.102.2024.03.27.17.25.39 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 27 Mar 2024 17:25:39 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel+bounces-122227-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b="LCTx/cDC"; arc=pass (i=1 dkim=pass dkdomain=intel.com dmarc=pass fromdomain=linux.intel.com); spf=pass (google.com: domain of linux-kernel+bounces-122227-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-122227-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id 588421C3158A for ; Thu, 28 Mar 2024 00:25:39 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 065133BBEC; Thu, 28 Mar 2024 00:22:56 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="LCTx/cDC" Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6958928E09; Thu, 28 Mar 2024 00:22:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=192.198.163.19 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711585374; cv=none; b=GI4Va4Vuetqzoxu/CRGGyMbfyv8W6d4ZtPhXEFuXVlniW8qwChLnUgJA8AmrK3h9BGQfhiUvSuWreT5VQSevnwufMmlVXJnS4x4i1BTUWa0GZqT5A5TVIlfkZ7iIYTlpWa7Msyy/fArg4QWp7vCyWXAQRyGIe3Rin2/xYtZ6jlM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711585374; c=relaxed/simple; bh=9w5lQ2pOZdanN4uPSlw3FqAR9K1n/EpTv9COUE47BCo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=e2dZ72P8Fj6eTst6/R6zms1tPRT5hS9ick1SMtmRY7ode3J1/TJfgu/MvEx6hhAMm47ZXPjs+hBWDQDJsZWF8U/YEOw5PukHBiOOSDn9K58+zlvWc5vpgujCPKqyQSR8AeAh9xctGK3j7aLLgKndLP54yHwVAE4utZCd7LehXso= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com; spf=none smtp.mailfrom=linux.intel.com; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b=LCTx/cDC; arc=none smtp.client-ip=192.198.163.19 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=linux.intel.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1711585372; x=1743121372; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=9w5lQ2pOZdanN4uPSlw3FqAR9K1n/EpTv9COUE47BCo=; b=LCTx/cDCUz/6FVxdazkTHlPhVQSMFM7OizrT6PtmYlypwxlPA07K/jUe EXct2Kw+7yF10sZ1yciyoSIRsBQnmJrMI87FNx4L+9BIlZCFNvBvqh+Kc bHbGeIcOs+CsBF35oDNCDYG+ZudErcXzoUafKT3BcSAewPt7XtXah3Y0y xZgepepxzbeb6osufOPUbdsD/DrZyVghMFWAmK5XQyRGOswHvI57p0HXq TLpeHxholq0ZLtf1tPSbFKFOQ0KK80ORZD4tP2xNW9FnAkPqFNwTUwToY 8o6dQLqHsHBBCRdqQKt1ckUmvDHe+/4HZaqkNduEtRYOEAJfUjgcUUwgz A==; X-CSE-ConnectionGUID: ZSIEtiMyT7KBqgsNRu2shw== X-CSE-MsgGUID: IHyDA+dHTCOqJ8UfkIWaPg== X-IronPort-AV: E=McAfee;i="6600,9927,11026"; a="6580748" X-IronPort-AV: E=Sophos;i="6.07,160,1708416000"; d="scan'208";a="6580748" Received: from orviesa009.jf.intel.com ([10.64.159.149]) by fmvoesa113.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Mar 2024 17:22:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.07,160,1708416000"; d="scan'208";a="16411821" Received: from b4969161e530.jf.intel.com ([10.165.56.46]) by orviesa009.jf.intel.com with ESMTP; 27 Mar 2024 17:22:32 -0700 From: Haitao Huang To: jarkko@kernel.org, dave.hansen@linux.intel.com, kai.huang@intel.com, tj@kernel.org, mkoutny@suse.com, linux-kernel@vger.kernel.org, linux-sgx@vger.kernel.org, x86@kernel.org, cgroups@vger.kernel.org, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de, hpa@zytor.com, sohil.mehta@intel.com, tim.c.chen@linux.intel.com Cc: zhiquan1.li@intel.com, kristen@linux.intel.com, seanjc@google.com, zhanb@microsoft.com, anakrish@microsoft.com, mikko.ylinen@linux.intel.com, yangjie@microsoft.com, chrisyan@microsoft.com Subject: [PATCH v10 13/14] Docs/x86/sgx: Add description for cgroup support Date: Wed, 27 Mar 2024 17:22:28 -0700 Message-Id: <20240328002229.30264-14-haitao.huang@linux.intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20240328002229.30264-1-haitao.huang@linux.intel.com> References: <20240328002229.30264-1-haitao.huang@linux.intel.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: Sean Christopherson Add initial documentation of how to regulate the distribution of SGX Enclave Page Cache (EPC) memory via the Miscellaneous cgroup controller. Signed-off-by: Sean Christopherson Co-developed-by: Kristen Carlson Accardi Signed-off-by: Kristen Carlson Accardi Co-developed-by: Haitao Huang Signed-off-by: Haitao Huang Cc: Sean Christopherson --- V8: - Limit text width to 80 characters to be consistent. V6: - Remove mentioning of VMM specific behavior on handling SIGBUS - Remove statement of forced reclamation, add statement to specify ENOMEM returned when no reclamation possible. - Added statements on the non-preemptive nature for the max limit - Dropped Reviewed-by tag because of changes V4: - Fix indentation (Randy) - Change misc.events file to be read-only - Fix a typo for 'subsystem' - Add behavior when VMM overcommit EPC with a cgroup (Mikko) --- Documentation/arch/x86/sgx.rst | 83 ++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/Documentation/arch/x86/sgx.rst b/Documentation/arch/x86/sgx.rst index d90796adc2ec..c537e6a9aa65 100644 --- a/Documentation/arch/x86/sgx.rst +++ b/Documentation/arch/x86/sgx.rst @@ -300,3 +300,86 @@ to expected failures and handle them as follows: first call. It indicates a bug in the kernel or the userspace client if any of the second round of ``SGX_IOC_VEPC_REMOVE_ALL`` calls has a return code other than 0. + + +Cgroup Support +============== + +The "sgx_epc" resource within the Miscellaneous cgroup controller regulates +distribution of SGX EPC memory, which is a subset of system RAM that is used to +provide SGX-enabled applications with protected memory, and is otherwise +inaccessible, i.e. shows up as reserved in /proc/iomem and cannot be +read/written outside of an SGX enclave. + +Although current systems implement EPC by stealing memory from RAM, for all +intents and purposes the EPC is independent from normal system memory, e.g. must +be reserved at boot from RAM and cannot be converted between EPC and normal +memory while the system is running. The EPC is managed by the SGX subsystem and +is not accounted by the memory controller. Note that this is true only for EPC +memory itself, i.e. normal memory allocations related to SGX and EPC memory, +e.g. the backing memory for evicted EPC pages, are accounted, limited and +protected by the memory controller. + +Much like normal system memory, EPC memory can be overcommitted via virtual +memory techniques and pages can be swapped out of the EPC to their backing store +(normal system memory allocated via shmem). The SGX EPC subsystem is analogous +to the memory subsystem, and it implements limit and protection models for EPC +memory. + +SGX EPC Interface Files +----------------------- + +For a generic description of the Miscellaneous controller interface files, +please see Documentation/admin-guide/cgroup-v2.rst + +All SGX EPC memory amounts are in bytes unless explicitly stated otherwise. If +a value which is not PAGE_SIZE aligned is written, the actual value used by the +controller will be rounded down to the closest PAGE_SIZE multiple. + + misc.capacity + A read-only flat-keyed file shown only in the root cgroup. The sgx_epc + resource will show the total amount of EPC memory available on the + platform. + + misc.current + A read-only flat-keyed file shown in the non-root cgroups. The sgx_epc + resource will show the current active EPC memory usage of the cgroup and + its descendants. EPC pages that are swapped out to backing RAM are not + included in the current count. + + misc.max + A read-write single value file which exists on non-root cgroups. The + sgx_epc resource will show the EPC usage hard limit. The default is + "max". + + If a cgroup's EPC usage reaches this limit, EPC allocations, e.g., for + page fault handling, will be blocked until EPC can be reclaimed from the + cgroup. If there are no pages left that are reclaimable within the same + group, the kernel returns ENOMEM. + + The EPC pages allocated for a guest VM by the virtual EPC driver are not + reclaimable by the host kernel. In case the guest cgroup's limit is + reached and no reclaimable pages left in the same cgroup, the virtual + EPC driver returns SIGBUS to the user space process to indicate failure + on new EPC allocation requests. + + The misc.max limit is non-preemptive. If a user writes a limit lower + than the current usage to this file, the cgroup will not preemptively + deallocate pages currently in use, and will only start blocking the next + allocation and reclaiming EPC at that time. + + misc.events + A read-only flat-keyed file which exists on non-root cgroups. + A value change in this file generates a file modified event. + + max + The number of times the cgroup has triggered a reclaim due to + its EPC usage approaching (or exceeding) its max EPC boundary. + +Migration +--------- + +Once an EPC page is charged to a cgroup (during allocation), it remains charged +to the original cgroup until the page is released or reclaimed. Migrating a +process to a different cgroup doesn't move the EPC charges that it incurred +while in the previous cgroup to its new cgroup. -- 2.25.1