From patchwork Fri Jan 12 23:56:20 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 13518782 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 8B908C4707C for ; Fri, 12 Jan 2024 23:56:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:Cc:To:In-Reply-To:References:Message-Id :MIME-Version:Subject:Date:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=y1+AugjMMh6faiCqTk6b2gLn2FvvBlXJ53B4Inx/w+I=; b=T3uXA22FMKIqjT puPEn5slwCjNAWfV+0Q+GJq9DTxYeaG3bqhSsTdJ+qeLlZrmkSf4zSIjkIRwSXzhCUKzYhzfosa54 urAQnd/X5hJDfkcQN/BgsG/o4o4EIJ26qWwhlocKGnEyEo9EsGC4KQ5usPzobbWapjz6BLn73wuIR 3t50Aqgitm8jN3XViKqTP4Uwj07lFzpXa1ZSmxKrqPlICJjiGWL3L8Xa27ZWthKnk/5qWWAEukerH SXSWAPCJe/PiXGF7o9rzdYx3fc2VUDPvdEKIkfxVuwjLYtRo6rm6DHHDvG+2y0PeZU4cTzzEcsVix +7qDzmLi0tStXQeSvvnA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rORO3-004HyG-1n; Fri, 12 Jan 2024 23:56:31 +0000 Received: from mail-io1-xd30.google.com ([2607:f8b0:4864:20::d30]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rORNy-004HwD-08 for linux-riscv@lists.infradead.org; Fri, 12 Jan 2024 23:56:29 +0000 Received: by mail-io1-xd30.google.com with SMTP id ca18e2360f4ac-7ba903342c2so375760739f.3 for ; Fri, 12 Jan 2024 15:56:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1705103784; x=1705708584; darn=lists.infradead.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=8ZPrT6/9y7GTRJXEMx1tnKXDzgpl8nPp7oBDsTEm8Wc=; b=VWQxk+PQFZfNxkH1ygTOsCVA/gDKtgw+fOqPqi/kLg4mMuxoYtgB4ubANESBnze6JH YhnEAx4bLCHnLbtaxdCKkMhFod4n2RLw/4M75v19U3wqKNNZrNyoZgmuQuZagcIca7Uc dYD7wtC+zckJEqhVCgdI8osma6eO8PIChIDB69FENwRWf+H+5bmtD3Z7WrHh1ROdpKY2 O0FwsdWNaQbbTchyjFjW+2s33Wfe4bNx//JEfvp9w3WXeZupb+elFmaBzmXliNP2Hh8M or1NNMXrIeGap4BlaSKWpTCc3L7NSg2xl0V5TFr+3YJk2fHOFUIKO3FOYMRdYrv9nuU5 1Nag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705103784; x=1705708584; 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=8ZPrT6/9y7GTRJXEMx1tnKXDzgpl8nPp7oBDsTEm8Wc=; b=jgoJxocQOsJX371Q1ek+CMf3E7X6D42PuTLAqak5LxUH3+I1gqzRGOivPR5ixxqv1K lAO6JxBu5T5beaI63FRM9I73aD9t9FAy+CtoCVb/sVqQYbDAgpHr9iakfNhBbxfCAfyE vsPMTIM2FZX0+z3o9R9YA43EJBFIvZOxWX6OZjGowFsKV9eys2I9v1iqx5tQS8XW0R9m Sj9Hb4hJhrf0bRLERx3IXZJSQ+lZJTbZx9nIjyRO0vwmGnX2U+HHCuOPX6TY2gMTclj7 SyL79I+qP0dgKKlDe9Vcq65/BU/LhrJ7IykQTo6IaZ/7zyZa1IHaWvwPjaX9qLeS+HCS eHOQ== X-Gm-Message-State: AOJu0YyzGTc1/eSnCt2DFumdrysddGMs7VYEnV8zD4p8oG/Pdo5gPG3o gkpUtP9n8BRqtLXpt5az5L0622hpFRvC4w== X-Google-Smtp-Source: AGHT+IHdFa0Z2vYPcCoDiJ3LsRWm/16BT/G+otM7tI1aKuDPn6A2GBUo8z6t3tR2U6vN86wYJYEnFQ== X-Received: by 2002:a92:d642:0:b0:35f:aba9:1031 with SMTP id x2-20020a92d642000000b0035faba91031mr2026091ilp.126.1705103783744; Fri, 12 Jan 2024 15:56:23 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id jc14-20020a17090325ce00b001d3b3ac2d7bsm3725537plb.245.2024.01.12.15.56.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Jan 2024 15:56:23 -0800 (PST) From: Charlie Jenkins Date: Fri, 12 Jan 2024 15:56:20 -0800 Subject: [PATCH v7 1/2] riscv: Include riscv_set_icache_flush_ctx prctl MIME-Version: 1.0 Message-Id: <20240112-fencei-v7-1-78f0614e1db0@rivosinc.com> References: <20240112-fencei-v7-0-78f0614e1db0@rivosinc.com> In-Reply-To: <20240112-fencei-v7-0-78f0614e1db0@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=1705103781; l=7834; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=IdbTkc3Q5t6sA8vLkrqSjebg3h+Stp0xkerv0GwEwco=; b=DFljA3ELwjm7M3ykiqZxlt6bGcQv8rzhZHSg/zi0qtVve1L7ETJZfuIxnYwlcJfFB4Uq9IHgt PFfuzrwL+8sDzjWUUZPkqIiowj+kAlIg28wSiK9URyZ6p/IrZR2H/en X-Developer-Key: i=charlie@rivosinc.com; a=ed25519; pk=t4RSWpMV1q5lf/NWIeR9z58bcje60/dbtxxmoSfBEcs= X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240112_155626_082191_B6281B66 X-CRM114-Status: GOOD ( 20.45 ) X-BeenThere: linux-riscv@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org Support new prctl with key PR_RISCV_SET_ICACHE_FLUSH_CTX to enable optimization of cross modifying code. This prctl enables userspace code to use icache flushing instructions such as fence.i with the guarantee that the icache will continue to be clean after thread migration. Signed-off-by: Charlie Jenkins Reviewed-by: Atish Patra --- arch/riscv/include/asm/mmu.h | 2 ++ arch/riscv/include/asm/processor.h | 6 ++++ arch/riscv/mm/cacheflush.c | 67 ++++++++++++++++++++++++++++++++++++++ arch/riscv/mm/context.c | 8 +++-- include/uapi/linux/prctl.h | 6 ++++ kernel/sys.c | 6 ++++ 6 files changed, 92 insertions(+), 3 deletions(-) diff --git a/arch/riscv/include/asm/mmu.h b/arch/riscv/include/asm/mmu.h index 355504b37f8e..60be458e94da 100644 --- a/arch/riscv/include/asm/mmu.h +++ b/arch/riscv/include/asm/mmu.h @@ -19,6 +19,8 @@ typedef struct { #ifdef CONFIG_SMP /* A local icache flush is needed before user execution can resume. */ cpumask_t icache_stale_mask; + /* Force local icache flush on all migrations. */ + bool force_icache_flush; #endif #ifdef CONFIG_BINFMT_ELF_FDPIC unsigned long exec_fdpic_loadmap; diff --git a/arch/riscv/include/asm/processor.h b/arch/riscv/include/asm/processor.h index f19f861cda54..7eda6c75e0f2 100644 --- a/arch/riscv/include/asm/processor.h +++ b/arch/riscv/include/asm/processor.h @@ -84,6 +84,9 @@ struct thread_struct { unsigned long vstate_ctrl; struct __riscv_v_ext_state vstate; unsigned long align_ctl; +#ifdef CONFIG_SMP + bool force_icache_flush; +#endif }; /* Whitelist the fstate from the task_struct for hardened usercopy */ @@ -145,6 +148,9 @@ extern int set_unalign_ctl(struct task_struct *tsk, unsigned int val); #define GET_UNALIGN_CTL(tsk, addr) get_unalign_ctl((tsk), (addr)) #define SET_UNALIGN_CTL(tsk, val) set_unalign_ctl((tsk), (val)) +#define RISCV_SET_ICACHE_FLUSH_CTX(arg1, arg2) riscv_set_icache_flush_ctx(arg1, arg2) +extern int riscv_set_icache_flush_ctx(unsigned long ctx, unsigned long per_thread); + #endif /* __ASSEMBLY__ */ #endif /* _ASM_RISCV_PROCESSOR_H */ diff --git a/arch/riscv/mm/cacheflush.c b/arch/riscv/mm/cacheflush.c index 55a34f2020a8..ff545f19f07a 100644 --- a/arch/riscv/mm/cacheflush.c +++ b/arch/riscv/mm/cacheflush.c @@ -5,6 +5,7 @@ #include #include +#include #include #include @@ -152,3 +153,69 @@ void __init riscv_init_cbo_blocksizes(void) if (cboz_block_size) riscv_cboz_block_size = cboz_block_size; } + +/** + * riscv_set_icache_flush_ctx() - Enable/disable icache flushing instructions in + * userspace. + * @ctx: Set the type of icache flushing instructions permitted/prohibited in + * userspace. Supported values described below. + * + * Supported values for ctx: + * + * * %PR_RISCV_CTX_SW_FENCEI_ON: Allow fence.i in userspace. + * + * * %PR_RISCV_CTX_SW_FENCEI_OFF: Disallow fence.i in userspace. When ``scope == + * PR_RISCV_SCOPE_PER_PROCESS``, this will effect all threads in a process. + * Therefore, caution must be taken -- only use this flag when you can + * guarantee that no thread in the process will emit fence.i from this point + * onward. + * + * @scope: Set scope of where icache flushing instructions are allowed to be + * emitted. Supported values described below. + * + * Supported values for scope: + * + * * PR_RISCV_SCOPE_PER_PROCESS: Ensure the icache of any thread in this process + * is coherent with instruction storage upon + * migration. + * + * * PR_RISCV_SCOPE_PER_THREAD: Ensure the icache of the current thread is + * coherent with instruction storage upon + * migration. + * + * When ``scope == PR_RISCV_SCOPE_PER_PROCESS``, all threads in the process are + * permitted to emit icache flushing instructions. Whenever any thread in the + * process is migrated, the corresponding hart's icache will be guaranteed to be + * consistent with instruction storage. Note this does not enforce any + * guarantees outside of migration. If a thread modifies an instruction that + * another thread may attempt to execute, the other thread must still emit an + * icache flushing instruction before attempting to execute the potentially + * modified instruction. This must be performed by the userspace program. + * + * In per-thread context (eg. ``scope == PR_RISCV_SCOPE_PER_THREAD``), only the + * thread calling this function is permitted to emit icache flushing + * instructions. When the thread is migrated, the corresponding hart's icache + * will be guaranteed to be consistent with instruction storage. + * + * On kernels configured without SMP, this function is a nop as migrations + * across harts will not occur. + */ +int riscv_set_icache_flush_ctx(unsigned long ctx, unsigned long scope) +{ +#ifdef CONFIG_SMP + switch (ctx) { + case PR_RISCV_CTX_SW_FENCEI_ON: + switch (scope) { + case PR_RISCV_SCOPE_PER_PROCESS: + current->mm->context.force_icache_flush = true; + break; + case PR_RISCV_SCOPE_PER_THREAD: + current->thread.force_icache_flush = true; + break; + default: + return -EINVAL; + } + } +#endif + return 0; +} diff --git a/arch/riscv/mm/context.c b/arch/riscv/mm/context.c index 217fd4de6134..0146c61be0ab 100644 --- a/arch/riscv/mm/context.c +++ b/arch/riscv/mm/context.c @@ -297,12 +297,14 @@ static inline void set_mm(struct mm_struct *prev, * * The "cpu" argument must be the current local CPU number. */ -static inline void flush_icache_deferred(struct mm_struct *mm, unsigned int cpu) +static inline void flush_icache_deferred(struct mm_struct *mm, unsigned int cpu, + struct task_struct *task) { #ifdef CONFIG_SMP cpumask_t *mask = &mm->context.icache_stale_mask; - if (cpumask_test_cpu(cpu, mask)) { + if (cpumask_test_cpu(cpu, mask) || mm->context.force_icache_flush || + (task && task->thread.force_icache_flush)) { cpumask_clear_cpu(cpu, mask); /* * Ensure the remote hart's writes are visible to this hart. @@ -332,5 +334,5 @@ void switch_mm(struct mm_struct *prev, struct mm_struct *next, set_mm(prev, next, cpu); - flush_icache_deferred(next, cpu); + flush_icache_deferred(next, cpu, task); } diff --git a/include/uapi/linux/prctl.h b/include/uapi/linux/prctl.h index 370ed14b1ae0..524d546d697b 100644 --- a/include/uapi/linux/prctl.h +++ b/include/uapi/linux/prctl.h @@ -306,4 +306,10 @@ struct prctl_mm_map { # define PR_RISCV_V_VSTATE_CTRL_NEXT_MASK 0xc # define PR_RISCV_V_VSTATE_CTRL_MASK 0x1f +#define PR_RISCV_SET_ICACHE_FLUSH_CTX 71 +# define PR_RISCV_CTX_SW_FENCEI_ON 0 +# define PR_RISCV_CTX_SW_FENCEI_OFF 1 +# define PR_RISCV_SCOPE_PER_PROCESS 0 +# define PR_RISCV_SCOPE_PER_THREAD 1 + #endif /* _LINUX_PRCTL_H */ diff --git a/kernel/sys.c b/kernel/sys.c index 420d9cb9cc8e..e806a8a67c36 100644 --- a/kernel/sys.c +++ b/kernel/sys.c @@ -146,6 +146,9 @@ #ifndef RISCV_V_GET_CONTROL # define RISCV_V_GET_CONTROL() (-EINVAL) #endif +#ifndef RISCV_SET_ICACHE_FLUSH_CTX +# define RISCV_SET_ICACHE_FLUSH_CTX(a, b) (-EINVAL) +#endif /* * this is where the system-wide overflow UID and GID are defined, for @@ -2739,6 +2742,9 @@ SYSCALL_DEFINE5(prctl, int, option, unsigned long, arg2, unsigned long, arg3, case PR_RISCV_V_GET_CONTROL: error = RISCV_V_GET_CONTROL(); break; + case PR_RISCV_SET_ICACHE_FLUSH_CTX: + error = RISCV_SET_ICACHE_FLUSH_CTX(arg2, arg3); + break; default: error = -EINVAL; break; From patchwork Fri Jan 12 23:56:21 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 13518783 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 551DEC4706C for ; Fri, 12 Jan 2024 23:56:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:Cc:To:In-Reply-To:References:Message-Id :MIME-Version:Subject:Date:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=gEGwCzogArIQsLl/esP0DqguW5YLD6CVjWu1ngAm2cw=; b=xxxDnUv8hMPtYY q5D1KsdKmZ/xCofXFb7w4XQwArzTt5cdNrMZ2lYbHobLnGee0Me9PlCxsnQHzdfScdncxViQ44WbM A3kFhJsQNJ+MVkzprv9nDiWogdaPi3eEOJcP9XyirE2YRmnyl1p6ekR9jcTvu4NvFQcGQXUku3Gs4 BKfUG6cT1hevPo8dje0WhQLh8TVJg0hsxcToirvA4hHEvNjjoC7nT40Nb+ONEHUTL+XUG12tbgmKw KrGo0Rct3sGIHRCHX9MG5bhu79mSrel4ucx2/YyDh8n+9YXSr6csocl4Rns/e7q5+L1qG2y+yJaNw I0ZhHhbTdAiPuJBaax9w==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rORO6-004HzX-0p; Fri, 12 Jan 2024 23:56:34 +0000 Received: from mail-pl1-x633.google.com ([2607:f8b0:4864:20::633]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rORO1-004HwG-32 for linux-riscv@lists.infradead.org; Fri, 12 Jan 2024 23:56:32 +0000 Received: by mail-pl1-x633.google.com with SMTP id d9443c01a7336-1d420aaa2abso45682665ad.3 for ; Fri, 12 Jan 2024 15:56:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1705103785; x=1705708585; darn=lists.infradead.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=rEBcVc42XhLbclEOiOTeHrqKkg/yMaKrCrHZS6upbrE=; b=NY4BwTYS6d/WVGRQM1+5rbWODX0uTLLlbdAv7bX7kwt9fcAyNLNKJfV5ygW8SYL+jT 9sk9vP/lQHhrqTHk3upmykj0/rVYL4oyNmpqZCu6mfiQ3o5kEEx1nWSIFQhjSDWDMxI8 Yq3QlRtDGEevpPoF+4KNzQfOxYWA8mTRTpewYFlKMJ2j1CCkvjmOuEJEKLsA03dn3fcG gFb5be6Mh+dJZLUvHot9tErDGe0r5cG1zbcLpmz0BUrXZQFf5XO7x+4l8j5YWprHOScy Z2xs2fj/WZQ7xoFmpa+Fr7cx6EMwCzheFsgNYx3ypataKqlsMpls9G/yTIpFgn3qNen5 Ag7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705103785; x=1705708585; 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=rEBcVc42XhLbclEOiOTeHrqKkg/yMaKrCrHZS6upbrE=; b=ZY7FAup9wCLlBEh/ZMMlbPqBF3X8DYAqUur2DLgYPu5OCTU/HyHlav1cmLjbCpMb/P /2w4WjAndR48AeVu8Ke7f9yT+cSCvPMrF5xsVNTicmqOyzwunEkJCZ4lY1TDfOrR9POf wEZZAkKl67lqdKMTEX9OSwJEOFjGCCTAigy6GsZiqROd+yYNFoFlLukhLwlq/EPoH5Ty sieuoRu7HfjHXKGSK2iNhY1I37hUGzLFQVZn/4A/t4qVIrg0u+LqJ1Nh5iWSnV70VCU9 voLI7ongsi9CAvdSXb0d0ll+XcpCkXcMO7/5FBfD12r95+A+2bixj6Rage0IuFoieTx/ ScSQ== X-Gm-Message-State: AOJu0YyxGy9jdeScXSuync/UkIaK8K1pNuBkWUqqyEXzWvjC1oeYrNF0 fwpp9fEbjLGKd69DGbD81FLw4r1AxhHeeA== X-Google-Smtp-Source: AGHT+IFNdcduop6iNi3vxZZxI1uKfQ5Yqs5N4fZW2gQaUsy/gPP8ax5VZ32FIDZCspddllFQdOuY/A== X-Received: by 2002:a17:90a:39ce:b0:28c:b190:7f85 with SMTP id k14-20020a17090a39ce00b0028cb1907f85mr1693150pjf.13.1705103785134; Fri, 12 Jan 2024 15:56:25 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id jc14-20020a17090325ce00b001d3b3ac2d7bsm3725537plb.245.2024.01.12.15.56.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Jan 2024 15:56:24 -0800 (PST) From: Charlie Jenkins Date: Fri, 12 Jan 2024 15:56:21 -0800 Subject: [PATCH v7 2/2] documentation: Document PR_RISCV_SET_ICACHE_FLUSH_CTX prctl MIME-Version: 1.0 Message-Id: <20240112-fencei-v7-2-78f0614e1db0@rivosinc.com> References: <20240112-fencei-v7-0-78f0614e1db0@rivosinc.com> In-Reply-To: <20240112-fencei-v7-0-78f0614e1db0@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=1705103781; l=3833; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=K6GU1jCnXJT3SY9+VUk3ZVtE1kDzv2SIhv7zwH/+BBM=; b=IIwtYnkypsYDf9+vi3bTkqQxfW18T9+8GE7LkRi/XsBDie8HMeanSj33rnURU6I++o2xxUcr+ RMM+6s5z2kOCPBLVFCEEsc9wRzO3ABlP9+RAZmyIWBEBaj1qTOBw6p7 X-Developer-Key: i=charlie@rivosinc.com; a=ed25519; pk=t4RSWpMV1q5lf/NWIeR9z58bcje60/dbtxxmoSfBEcs= X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240112_155630_023511_AA5D1D49 X-CRM114-Status: GOOD ( 17.45 ) X-BeenThere: linux-riscv@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org 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..7ae8ababa039 --- /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, 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