From patchwork Mon Jan 8 06:21:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 185818 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:37c1:b0:101:2151:f287 with SMTP id y1csp855406dyq; Sun, 7 Jan 2024 22:22:44 -0800 (PST) X-Google-Smtp-Source: AGHT+IG8Yp5cNYS+sAMnHC4aK86+FPgW/5uylJjasZJIoJ45OMEhnPhD0Zj9WIeGFtVWOHaYHQzQ X-Received: by 2002:a17:903:41d2:b0:1d0:6b95:9bfe with SMTP id u18-20020a17090341d200b001d06b959bfemr1159668ple.1.1704694963986; Sun, 07 Jan 2024 22:22:43 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704694963; cv=none; d=google.com; s=arc-20160816; b=s/lqJm96+NOP7LUJqiAflqzYsSy+T8KgTbz884qkBgzfIcjzx5JRG0n3aHNPe2Xot2 ljyKexMvosbH6lyS9twBEu0dpuhyBPc3H8v6TeatgAAHF6eg4IA1qRgXzcoVIR0o6gts sU0AC/kZxOXnk8fhJU/EsYOG0gdUCXiwufsHpaEXVUViLJhCiXEGWB8wWQk0RR1ZSRd9 riKe8A7jp4W+NsmYY9ZlPy1hRw3wE4eoHBn3IDmhQtowpBFBY+2MzuUHZh6zqSMtWNo2 8sofykPAKz6LWW9TFRCqV4ztUzfXhwslDgHkfo8WAdt1qsMEL5TUrs0UbdIuacF+WHeM oHlg== 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=7zIxoN+SgU88Z6qGdoK7DlJzsgAjm+cXBEiUMLpGQcU=; fh=e1JlwtUWRFbXk6Wk02UhhK0dSnd5ZqIT5IDANNgKwN8=; b=gGARUgvpYOViE/TfPhOMmQvOXWmRe9QI4JNOyJfYi/y//IS5deepq0+guxjIizDT2w NTnvUhj/2SaYJphMUs0YstqGSC2s5wSmpKyUsGSolvvor1ItH3WPoy26nJBkc2BsbqG9 nblbc1C77MtAMU+ukPg/W4skhndH9G3qoIo/M7iia7BuS0K67YTg97qIrKcvvNOsKP1L M5YWrgN+retjd5SYmx1MGHF9oW7yp69tGG0KONPdpImjR2CshnTEX2aONHaQNYS3NBHN rUsE6ScrAr9h9C0tUyAR7zH9ye1cz92cACoVd1FaMMHcwuBVCl8ILKWZ/R/A/mbvpH/5 UU1Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=K2fhodUs; spf=pass (google.com: domain of linux-kernel+bounces-19098-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-19098-ouuuleilei=gmail.com@vger.kernel.org" Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [139.178.88.99]) by mx.google.com with ESMTPS id p2-20020a170902eac200b001d3fe0117dcsi5603233pld.54.2024.01.07.22.22.43 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 07 Jan 2024 22:22:43 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-19098-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99; Authentication-Results: mx.google.com; dkim=pass header.i=@rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=K2fhodUs; spf=pass (google.com: domain of linux-kernel+bounces-19098-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-19098-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 sv.mirrors.kernel.org (Postfix) with ESMTPS id BD7CA281C54 for ; Mon, 8 Jan 2024 06:22:43 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id A232BBA57; Mon, 8 Jan 2024 06:21:57 +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="K2fhodUs" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-ot1-f52.google.com (mail-ot1-f52.google.com [209.85.210.52]) (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 77E498473 for ; Mon, 8 Jan 2024 06:21:53 +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-ot1-f52.google.com with SMTP id 46e09a7af769-6dc53fc4b0dso1155105a34.2 for ; Sun, 07 Jan 2024 22:21:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1704694912; x=1705299712; 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=7zIxoN+SgU88Z6qGdoK7DlJzsgAjm+cXBEiUMLpGQcU=; b=K2fhodUssilWIgz7HUJpifg0MUGRWZ3zKMQSdErBcmytWZOJ9OmYGmYINohiwcZCfe pTlAJMrOkXw9NcRYApsVYX0GgVps7kUI43ot5hxEC3Xwy9kLYG5iCY900phT84I3HPoD he66wcPQi+n1KQp+Ux52FqpumdrMwfm3hHF9LvqNKm1ZiSDnLOnOZDnbkqdfg9EPev3B b89h7T64yXaaUdQguJ3ICVdrt67d9oKubOauLZG7I4l5PlhsHvH8eGYn+I8ClxQiM705 SYzt7coeMQJ4d46tyBQEJHmRlRHP163TpxDI1nDYMyAjmQ+P+SaNLbbk0Zfn0EzgCSRI ueQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704694912; x=1705299712; 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=7zIxoN+SgU88Z6qGdoK7DlJzsgAjm+cXBEiUMLpGQcU=; b=um80RZjmkv4CySQulS/8axGV5GUiLcZ2K5qZeqD4Zn6l8dR/zMT/nZ4qbFGb+ddSYc LRywnrHyr6tnjugW0q53M3IXScwLb6EobP4BkDH1X6rZgRL5/oKEpnPZ2gY4MIc3Cyd4 kQCwkC98dXmJBvvLeu+QidlO+K9GXYbZY+unSSzgRze7zF9lQzxq1sSIYvDWI1tJ9lZw gI1V+xg5Z9Q8HAkHA6999Znj59JBCbI6ORR5MJexszOCrZpWIvROhRbkXx9J1SmpQku4 xoiKJlL0fn/yB+nlQV2mCG0hLnMbCs4a0wlH5ft6RzyeIzOEwlGrcCPvQmJw0rW2Rhm+ a/Fg== X-Gm-Message-State: AOJu0Yzg6l2cXferjrRzTdKuwqP9peCx75BoUD1xB+bcFq7GcCh7EQ94 8a0z0+aG3jodSsqfQYa/ThZjcPY3qTGkCA== X-Received: by 2002:a9d:7a85:0:b0:6db:95ba:c422 with SMTP id l5-20020a9d7a85000000b006db95bac422mr2004194otn.41.1704694912539; Sun, 07 Jan 2024 22:21:52 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id i12-20020a9d53cc000000b006dba99e1835sm1274322oth.4.2024.01.07.22.21.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 07 Jan 2024 22:21:52 -0800 (PST) From: Charlie Jenkins Date: Sun, 07 Jan 2024 22:21:46 -0800 Subject: [PATCH v4 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: <20240107-fencei-v4-2-d4cf2fb905d3@rivosinc.com> References: <20240107-fencei-v4-0-d4cf2fb905d3@rivosinc.com> In-Reply-To: <20240107-fencei-v4-0-d4cf2fb905d3@rivosinc.com> To: Paul Walmsley , Palmer Dabbelt , Albert Ou , Jonathan Corbet , Conor Dooley , =?utf-8?b?Q2zDqW1lbnQgTMOpZ2Vy?= , Atish Patra Cc: linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Charlie Jenkins X-Mailer: b4 0.12.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1704694908; l=3764; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=somI31K4e1DNhLYi544ikiKSJVE5TPTc178CdwxSACE=; b=wOjyNp3Bafs5E4EAXPZDcY5CMZv7eGYP53YeKRTCExbTq0Ej9zlAWZ2834TSECygPHMj+NHYv 9lX1K2SdI/4Dy5Tn8rFusqYzrPJcIbPyqyeQcXJdQVXSC5NuhF6Mkt6 X-Developer-Key: i=charlie@rivosinc.com; a=ed25519; pk=t4RSWpMV1q5lf/NWIeR9z58bcje60/dbtxxmoSfBEcs= X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787502226539024021 X-GMAIL-MSGID: 1787502226539024021 Provide documentation that explains how to properly do CMODX in riscv. Signed-off-by: Charlie Jenkins --- 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..71598850e131 --- /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) is 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. + +1. 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