From patchwork Tue Jan 9 18:43:26 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 186513 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2411:b0:101:2151:f287 with SMTP id m17csp311181dyi; Tue, 9 Jan 2024 10:44:32 -0800 (PST) X-Google-Smtp-Source: AGHT+IFcpJ9CMsY8I7+QJFJOW+VCg5WkNlP0InT15MpIEKeYV3T/Wx04xRXyPk6nAmChfOb1rhA5 X-Received: by 2002:a17:906:fb98:b0:a28:b744:62de with SMTP id lr24-20020a170906fb9800b00a28b74462demr386854ejb.54.1704825872478; Tue, 09 Jan 2024 10:44:32 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704825872; cv=none; d=google.com; s=arc-20160816; b=HA+axxY20eM8sUmjIrc4cgE6r47gIUMrrXtj+v4JrCS62SbWwJXO6r0A+2qk5XXj9V CuidbrLeURcW7PU57eJMMpdtBfRmI2K8LRvycn/RHM2jTKMdeSTgFu5uZ5pAZLtuTQ09 4+QrwrE9VvAEhltrnGDFl3ktVlD2NH+AIoY1hGGPt/Fqz3koSpO7rEH1qenHLJ8Sh5X0 a1Gh27MWLpRq+oi8sE4PRTSe4IEye2WGEy47CcJy/V0CfgbmwP8vQk788aNMwcnSfjfk GreFGOpNohJF0lSAIkYQjcqt/+ReNt0p2pASpwTmuJSY9zSZjzxlQZpnoHIyosQ3Ly2S 3bLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:list-unsubscribe:list-subscribe:list-id:precedence :subject:date:from:dkim-signature; bh=H1NNXG/cc6Ss9zFsC2xjmXCCDBeblJidGJDKM2XVVV0=; fh=qPogcCrLsCYBo/9TCOpP+gmFKVDqSFHDtiwHbevqSF8=; b=aVJ0zPLqITmohqaFg9Z67kxoVvDtjePhyu9Y1nznSAw8W9fE7crZLQkBvjVZPsnJR7 4v1zb78SQUlC+IfbM3508hTbtv50zoBAbIG3N7MIrLOEqNhjXiOLv5e31lStPnHqPtQj ksK9fC1G1Ao5FUjuEHmL4gyH1JUVgK3Pcmsm5lN9QoZKaQoU7Olivys+oDoqbSEq4VdO xYHI6EvbygnvO17D7lNf22xYB95R69mPROr9gYTvLqcLPxHn7L5sPuAeA/VKkJSAjOe1 iJgQod0FvHHtnZ8o/x4DhaTZc49wQiVi0ToOapKszNQJQVKWhpxBewvqDUKFxK4oI3To V6bg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=tOSB6VHy; spf=pass (google.com: domain of linux-kernel+bounces-21273-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-21273-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [2604:1380:4601:e00::3]) by mx.google.com with ESMTPS id o13-20020a17090611cd00b00a275b4b24dfsi989999eja.789.2024.01.09.10.44.32 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jan 2024 10:44:32 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-21273-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; Authentication-Results: mx.google.com; dkim=pass header.i=@rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=tOSB6VHy; spf=pass (google.com: domain of linux-kernel+bounces-21273-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-21273-ouuuleilei=gmail.com@vger.kernel.org" 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 am.mirrors.kernel.org (Postfix) with ESMTPS id E8F041F268A3 for ; Tue, 9 Jan 2024 18:44:31 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id D5C9A3D54B; Tue, 9 Jan 2024 18:43:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=rivosinc-com.20230601.gappssmtp.com header.i=@rivosinc-com.20230601.gappssmtp.com header.b="tOSB6VHy" Received: from mail-oi1-f169.google.com (mail-oi1-f169.google.com [209.85.167.169]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 524243C482 for ; Tue, 9 Jan 2024 18:43:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=rivosinc.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=rivosinc.com Received: by mail-oi1-f169.google.com with SMTP id 5614622812f47-3bbbc6b4ed1so2584305b6e.2 for ; Tue, 09 Jan 2024 10:43:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1704825810; x=1705430610; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=H1NNXG/cc6Ss9zFsC2xjmXCCDBeblJidGJDKM2XVVV0=; b=tOSB6VHykhe00dCiINpfjpyxNqbdE3/3KIHmLnFwVmX1P4o/QHFhlh7sYPYvtpFK5b ob88tGRsgf4zHwaNJJB/1vh5m8zM2M2HJxhjA8OG9fX7mscv3alwqpP5nOZNTTGFbQuJ xhSoQe+MoLeakS+XcslD8Qn8C8Tn0jIsRI2jz9I5xB9bdP2+fTf3S5fdbOvspMKwS0Vr ck0h2xS+KvMNoqiRIOnF6sPWCNdKbC9t3tofB4cALm8ISSVZ02tZRJgzE1/hhx/fY/zQ wkLfXBBTOp3QyJH8oiiPFX65hq/DiTkfQCNmr8QRJh2C8mYunlgeKJULC9wMEAJcloao 3h8g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704825810; x=1705430610; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=H1NNXG/cc6Ss9zFsC2xjmXCCDBeblJidGJDKM2XVVV0=; b=WYS4ZHKsmqEctoYRPRGRn/a2EZjGOc+IAXtpbV61R7HwPqBqGNwbFUOA5sW0FaYa/r FmHr+s8Ooc1askwsoYz5W1ELxi2xdvXItpc4eBm8palQigOnkKj4exaDkW+cdg6TDlCz AhcbuXM8vas2TDeLXJdfPkTWiU24U1dsg2QU4OdJRQKpRSg3wpmy3K71vvcs4fHiteAD dOE3q9VBaz85TBWjDTS4tu4eOLyMFItVobjNLmdPpb0KKpS1yz77X/18/VtTSxct3a00 vtoE2YUFBp4LL0Zk1kXFFZVsFKQNi5MdBjUebzzDIBbhWy3PF/rHkdifdKJ328estw4J 3k9Q== X-Gm-Message-State: AOJu0YysrefxYX5gR8NWhOoHHSeDVumJ+1n5wimvuPtFIIzEBQHxmWdL yyUH2HRdyNWUL8NcMxKw31zhcKR7zemN7A== X-Received: by 2002:a05:6870:7884:b0:203:18e9:804a with SMTP id hc4-20020a056870788400b0020318e9804amr6057763oab.86.1704825810491; Tue, 09 Jan 2024 10:43:30 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id j2-20020a9d7682000000b006ce2c31dd9bsm450423otl.20.2024.01.09.10.43.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jan 2024 10:43:30 -0800 (PST) From: Charlie Jenkins Date: Tue, 09 Jan 2024 10:43:26 -0800 Subject: [PATCH v6 2/2] documentation: Document PR_RISCV_SET_ICACHE_FLUSH_CTX prctl Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20240109-fencei-v6-2-04116e51445c@rivosinc.com> References: <20240109-fencei-v6-0-04116e51445c@rivosinc.com> In-Reply-To: <20240109-fencei-v6-0-04116e51445c@rivosinc.com> To: Paul Walmsley , Palmer Dabbelt , Albert Ou , Jonathan Corbet , Conor Dooley , =?utf-8?b?Q2zDqW1lbnQgTMOpZ2Vy?= , Atish Patra , Randy Dunlap Cc: linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Charlie Jenkins , Atish Patra X-Mailer: b4 0.12.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1704825806; l=3808; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=ABgVzoDksDxj5OqFX0a7CWpy1eY9QNcsIJ1Zy7mwIys=; b=j5GVuprP0qn0h0qUpUY2k2ew7NlFi46kdG1k0oqIUc112oHNCCD9SA9tXCDEIg4X1qkZqh5ZH tINoTxCG7+yAyv173/RET8VuEsm9gqic+JA7gneMpiQeImMmqHv0Dot X-Developer-Key: i=charlie@rivosinc.com; a=ed25519; pk=t4RSWpMV1q5lf/NWIeR9z58bcje60/dbtxxmoSfBEcs= X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787639494285965017 X-GMAIL-MSGID: 1787639494285965017 Provide documentation that explains how to properly do CMODX in riscv. Signed-off-by: Charlie Jenkins Reviewed-by: Atish Patra --- Documentation/arch/riscv/cmodx.rst | 88 ++++++++++++++++++++++++++++++++++++++ Documentation/arch/riscv/index.rst | 1 + 2 files changed, 89 insertions(+) diff --git a/Documentation/arch/riscv/cmodx.rst b/Documentation/arch/riscv/cmodx.rst new file mode 100644 index 000000000000..afd7086c222c --- /dev/null +++ b/Documentation/arch/riscv/cmodx.rst @@ -0,0 +1,88 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================================================================== +Concurrent Modification and Execution of Instructions (CMODX) for RISC-V Linux +============================================================================== + +CMODX is a programming technique where a program executes instructions that were +modified by the program itself. Instruction storage and the instruction cache +(icache) are not guaranteed to be synchronized on RISC-V hardware. Therefore, the +program must enforce its own synchronization with the unprivileged fence.i +instruction. + +However, the default Linux ABI prohibits the use of fence.i in userspace +applications. At any point the scheduler may migrate a task onto a new hart. If +migration occurs after the userspace synchronized the icache and instruction +storage with fence.i, the icache will no longer be clean. This is due to the +behavior of fence.i only affecting the hart that it is called on. Thus, the hart +that the task has been migrated to may not have synchronized instruction storage +and icache. + +There are two ways to solve this problem: use the riscv_flush_icache() syscall, +or use the ``PR_RISCV_SET_ICACHE_FLUSH_CTX`` prctl() and emit fence.i in +userspace. The syscall performs a one-off icache flushing operation. The prctl +changes the Linux ABI to allow userspace to emit icache flushing operations. + +prctl() Interface +--------------------- + +Call prctl() with ``PR_RISCV_SET_ICACHE_FLUSH_CTX`` as the first argument. The +remaining arguments will be delegated to the riscv_set_icache_flush_ctx +function detailed below. + +.. kernel-doc:: arch/riscv/mm/cacheflush.c + :identifiers: riscv_set_icache_flush_ctx + +Example usage: + +The following files are meant to be compiled and linked with each other. The +modify_instruction() function replaces an add with 0 with an add with one, +causing the instruction sequence in get_value() to change from returning a zero +to returning a one. + +cmodx.c:: + + #include + #include + + extern int get_value(); + extern void modify_instruction(); + + int main() + { + int value = get_value(); + printf("Value before cmodx: %d\n", value); + + // Call prctl before first fence.i is called inside modify_instruction + prctl(PR_RISCV_SET_ICACHE_FLUSH_CTX_ON, PR_RISCV_CTX_SW_FENCEI, 0); + modify_instruction(); + + value = get_value(); + printf("Value after cmodx: %d\n", value); + return 0; + } + +cmodx.S:: + + .option norvc + + .text + .global modify_instruction + modify_instruction: + lw a0, new_insn + lui a5,%hi(old_insn) + sw a0,%lo(old_insn)(a5) + fence.i + ret + + .section modifiable, "awx" + .global get_value + get_value: + li a0, 0 + old_insn: + addi a0, a0, 0 + ret + + .data + new_insn: + addi a0, a0, 1 diff --git a/Documentation/arch/riscv/index.rst b/Documentation/arch/riscv/index.rst index 4dab0cb4b900..eecf347ce849 100644 --- a/Documentation/arch/riscv/index.rst +++ b/Documentation/arch/riscv/index.rst @@ -13,6 +13,7 @@ RISC-V architecture patch-acceptance uabi vector + cmodx features