From patchwork Tue Jan 23 23:29:52 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 191251 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2553:b0:103:945f:af90 with SMTP id p19csp665302dyi; Tue, 23 Jan 2024 15:32:27 -0800 (PST) X-Google-Smtp-Source: AGHT+IHfxTDTAW8FJSwMr7PqfxIQ0qoKBTVpZQe3Av6Uw4yCy6uF8HJJ/GBb0fthQ8yLmB3g10B0 X-Received: by 2002:a05:6402:5245:b0:55c:99b9:8f9e with SMTP id t5-20020a056402524500b0055c99b98f9emr724723edd.55.1706052747593; Tue, 23 Jan 2024 15:32:27 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706052747; cv=pass; d=google.com; s=arc-20160816; b=Wku0FLNpCJu7mq8jKGgK6n+2M6lNQN2pShvA1OGlvDEmwiGKVcaVgksa6xX/ZesMV9 0jWl8kiHq3WYlGfvR7pZ/HxcO3Zd6MfJRkOHL6Cs1Nz747tfG5NsxLK6gYnZ/q8ENcj7 kri6MhuRX90vb2s9KbAROE9DgJ24+hQx5t5qxrnEBEah9oFVyCXZzixWi5JQEpcAZNL2 laLDwZROlt1B2ray2etfx/vi4VxpRIuCt6piky2Frtt9DOsdh+urP+snwqhB4CIn66Dy cs1ydGYej/fAQjZar7B95DFGeHqWTxMvw+Ikd9uVy4nhq/FdysJMzmKj9axQzVJMJccr vHeg== ARC-Message-Signature: i=2; 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=ypj/UfIhrHcfkXvw9Dauu4SlRhzY7WsoxY+bpEphFSM=; fh=/XXWyXb92ihsaKNKqSDb4nUFODn0XZjcGSlWepA+YcI=; b=bfmXUR113+g7VeZS+K+fJjwTEquP9Sur+NcrvvBfu/FlUT1FeXb90Jqxr3G5nhJTum ONwgynkqsN+uJ1ReAiTmKLHBX/YFslNYcDC88mrfRuA66Gq1LF+9qG+uCoUTasqusyjM nramdzlApeGVDet8iaFfdX7TfF0jPrP/x51YUBEYqErFqqpQ4RcNnkRuQfPGqwM+hwTx N3Pax8YuI7bJezYyw1QAEpvAMm68/L7YWIcPifCrkSYRRz0S71uQU1lBooV42Xh4ahgH NFFJQytxcbu6qLl7NhmkzbPYewuf9K91e+d9gmvZQlkFl521U+udvJ0aUwbj75+YjNVf haHA== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=1hkWzx9y; arc=pass (i=1 spf=pass spfdomain=rivosinc.com dkim=pass dkdomain=rivosinc-com.20230601.gappssmtp.com); spf=pass (google.com: domain of linux-kernel+bounces-36189-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-36189-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id g25-20020a056402321900b0055a3abbbfaesi6071798eda.323.2024.01.23.15.32.27 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 15:32:27 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-36189-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=1hkWzx9y; arc=pass (i=1 spf=pass spfdomain=rivosinc.com dkim=pass dkdomain=rivosinc-com.20230601.gappssmtp.com); spf=pass (google.com: domain of linux-kernel+bounces-36189-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-36189-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 13B4F1F239E4 for ; Tue, 23 Jan 2024 23:32:27 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id BBAC15A796; Tue, 23 Jan 2024 23:31:29 +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="1hkWzx9y" Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.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 AA9C15466F for ; Tue, 23 Jan 2024 23:31:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706052686; cv=none; b=NRTN0ZcGEZHMjPhzQEUUvt9H552LL3PzSjXbAc4UCSSARmEwU0KrOvytaiaedjpTabfP2JDGSSycipzeS66xw7B5ojy0+5+GFsw7HH/7AVb30l6Wq5RYJ7S/jARjU2Yt/jl31Kc5/eJGPABCaBWAwQHc2hztAhAOnkLhMs0e5Xc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706052686; c=relaxed/simple; bh=s1vPZ9pBqnCgTaBmMZz76e14UF6RK2nnhmaQL0fr1PM=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=EQO4FWMGLCc/9onmGs1YApg0jv5KUtDLkhdPQ4+Wf0aY+SRm9H6+8cq4AboG8fGt0/B4qH59nj6C2j1oXJ/bnzltBG3famTEq5XaEkeUxY5acpkW409TkBjFwXDBab6XmMB95Wg1lAivNTkhmWpWojGZJ4TpkhjRuMVvCgoVmbo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=rivosinc.com; spf=pass smtp.mailfrom=rivosinc.com; dkim=pass (2048-bit key) header.d=rivosinc-com.20230601.gappssmtp.com header.i=@rivosinc-com.20230601.gappssmtp.com header.b=1hkWzx9y; arc=none smtp.client-ip=209.85.216.52 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-pj1-f52.google.com with SMTP id 98e67ed59e1d1-290b1e19101so1697213a91.0 for ; Tue, 23 Jan 2024 15:31:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1706052684; x=1706657484; 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=ypj/UfIhrHcfkXvw9Dauu4SlRhzY7WsoxY+bpEphFSM=; b=1hkWzx9yfbFvtu2kbt79azyWxGP5klJuNLd8LpolL8auuYdNQ9QIO/kxRipHEuG49H PgMJfuRzF5oitkGew1wIvbyusHpZ+fzayK5Rar9iXRxJjlJAo01OvaNXHm+BPvYNtop0 jtexfPvct+ouwZ2Guj/1A1G4o8ddgXKXVnRx/YGscnjq+nGawFUj6eIgEiVjuoHVTRqr z9ObsVAqsW4o3QwjJAjnBErocLVLYeg6QlpYfCF+VzT2VtUlndVXQsya0/wRIC/bP5Sk riVZdJXVP7ELAo5woX34Oj1iRPlmnafieTLDtULHSQY31skZpWbyzt8FqMURWI7S4dgt SzMw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706052684; x=1706657484; 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=ypj/UfIhrHcfkXvw9Dauu4SlRhzY7WsoxY+bpEphFSM=; b=ckmENAPNeOoD9oEiZ3bMkAKOZ4R8EFjGhMrXU+l0V9se64QdMdcIOrwtKesW0YyzRJ LAZjrr+VBTS8C+DqaNe92nDDBYWO2x1U13gzeGihSQ/mwhxRVdWSoYfdvWa/r2yRfKtW bE+U6xowMCV+RrTAxCtwo0qncWZPa5y43kJu8RexHkUm9uWV6xJoXj7hoP6vacr6YoZn 44dLL9OlFdUDbEwSoJGliqlzHChzCGgJlbJ48Z1/yR+h0kDVbViXN8ZHrzG35N+2OYJ+ UF3PDJc8zeq/TX1uFu5RV+lAtdQ0wP+gnAdzaIBcEahQq6G+SQDD0s8KuQVnPixBaQAD J9mQ== X-Gm-Message-State: AOJu0YysC/EHJ/jwN47j/96MxGB1phsUBKx3JNQzpXc2duWfDQD91sIu kCiFFPiXkm2lgA1FqcNZpn/osL12Gxd8WbzqeQvMD53hwqCBFh1uhQ0zzQZFV4I= X-Received: by 2002:a17:90a:4b4c:b0:28d:1581:29e6 with SMTP id o12-20020a17090a4b4c00b0028d158129e6mr432143pjl.13.1706052684090; Tue, 23 Jan 2024 15:31:24 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id eu15-20020a17090af94f00b0028d19ddb1afsm12150698pjb.33.2024.01.23.15.31.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 15:31:23 -0800 (PST) From: Charlie Jenkins Date: Tue, 23 Jan 2024 15:29:52 -0800 Subject: [PATCH v9 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: <20240123-fencei-v9-2-71411bfe8d71@rivosinc.com> References: <20240123-fencei-v9-0-71411bfe8d71@rivosinc.com> In-Reply-To: <20240123-fencei-v9-0-71411bfe8d71@rivosinc.com> To: Paul Walmsley , Palmer Dabbelt , Albert Ou , Jonathan Corbet , Conor Dooley , =?utf-8?b?Q2zDqW1lbnQgTMOpZ2Vy?= , Atish Patra , Randy Dunlap , Alexandre Ghiti 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=1706052680; l=4373; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=s1vPZ9pBqnCgTaBmMZz76e14UF6RK2nnhmaQL0fr1PM=; b=Ur9C/GYjVRc9cfGP6lbfdLcd5+hrocoQQ3dJe0KO4KsYN3HCUO6zjvu2mV8SSw3XAXQTLvrtX FAcuM9z45lnCp+iAcp2yvi2SBh+OuWVcEO/LKKTp8kBQdt/sOG6QIjp X-Developer-Key: i=charlie@rivosinc.com; a=ed25519; pk=t4RSWpMV1q5lf/NWIeR9z58bcje60/dbtxxmoSfBEcs= X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788925965599949734 X-GMAIL-MSGID: 1788925965599949734 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 | 96 ++++++++++++++++++++++++++++++++++++++ Documentation/arch/riscv/index.rst | 1 + 2 files changed, 97 insertions(+) diff --git a/Documentation/arch/riscv/cmodx.rst b/Documentation/arch/riscv/cmodx.rst new file mode 100644 index 000000000000..2ad46129d812 --- /dev/null +++ b/Documentation/arch/riscv/cmodx.rst @@ -0,0 +1,96 @@ +.. 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. + +As an aside, "deferred" icache flushes can sometimes be triggered in the kernel. +At the time of writing, this only occurs during the riscv_flush_icache() syscall +and when the kernel uses copy_to_user_page(). These deferred flushes happen only +when the memory map being used by a hart changes. If the prctl() context caused +an icache flush, this deferred icache flush will be skipped as it is redundant. +Therefore, there will be no additional flush when using the riscv_flush_icache() +syscall inside of the prctl() context. + +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, PR_RISCV_SCOPE_PER_PROCESS); + 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