From patchwork Wed Jan 17 02:54:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 13521375 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 643BFC47DA2 for ; Wed, 17 Jan 2024 02:54:58 +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=DTPC18AJUSk4LwgF+2pShzJLkylZFV2QqjD7OWR08Xg=; b=UZwJLy0OtlC20D RSH7wnW80SNZiVV84ug6PJkZadA64KLzZIOyjZNPfSK3rh2k2GmfhSFB6EnBbXplwNnfkk6sY8EQe p7MU2PYyLlVTsHkSe5TaXVVDxJbLELHwnIeLKLdykRsSHjG9A362nkpNiGbpOIEpIapCE9G9Tw+nM L3GgfNRRcGE6Odg6YUgBL9R87YIJ3XO+q5PCqgZjkCi9zKG5OulzPkxNEkttF01xtwoG6qNXRfsdA dDAVgkwTwKOKWAsvgku+ez38U9AJvkJ8SBugT+Jy3039tnJc4wv+9xGsz+W/WR0mReO7EWRR5Gm7G GLQQtzlv4Zi8TqTfbVJA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rPw4j-00EGHH-2a; Wed, 17 Jan 2024 02:54:45 +0000 Received: from mail-pg1-x52b.google.com ([2607:f8b0:4864:20::52b]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rPw4f-00EGE4-0L for linux-riscv@lists.infradead.org; Wed, 17 Jan 2024 02:54:44 +0000 Received: by mail-pg1-x52b.google.com with SMTP id 41be03b00d2f7-5ce74ea4bf2so6660452a12.0 for ; Tue, 16 Jan 2024 18:54:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1705460074; x=1706064874; 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=SfRQ2SqB32USoG2KdbR8jDXMoRS1QawAEPSQ84qcbpM=; b=S7gjJG6532DkXDOD6EJtu5nKuC2Cfz+kQFiuh2KWywARF0Rws29Iy1xNfSNK8q87rO UVsY6iC7v3vIyeIPXRNKdZ+Qx0HYtxo1j+0Xck6QNiF3oenZnXPlWk90GI+SgUScZ5JY J/TO1WMovTjgZE6CCc8rr36ra06qEDcjScfgOmMw2MDeGX0SPkfEud0z337XCVVOZWIp VMGdm1JDafRu9luAeuqooHfNaXLqPNvnfYcE7qBzhlnKRefhRZZr+IGQnwdPNohrWvEY XH+IdQqee6wgEMXa9sCMsxUSxj+18Y/48e43RGv8ysO770iQ0oScIukyOZFdTWaTjedX zsuA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705460074; x=1706064874; 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=SfRQ2SqB32USoG2KdbR8jDXMoRS1QawAEPSQ84qcbpM=; b=OmG+2aw3tZCF6fHqdQG09W2VegawRrNUoOcAUrB2TtyjPK0B3KDEJPcHQ+cmioIwCi mE0oMKMf9PkuCiY2KEJSpmw4tgIYVinscLGzQ2C4MyKrxAhJ+RpjG3xnslivIUpQhNLB SmIDBNG6vFIoJfHk00dxsH5ljXyj4+g11uEaDM5PfBXumCNDpQtwMsguBUB9fzWAF8B7 7ZZuQ6wMMGhJ5b0V9DHg5AkHDxXsJgq3N9JuBFxmHlqHXeaQVaVkXduaVZKu8EmCqhjG V79iathjBx769t1Yh98qmKj6BwT5U2TAsYRF42dYS0jf7Cv4VMxMWDqZqbSe5x1/tmGo eiJA== X-Gm-Message-State: AOJu0Yw7AJMh8Gzui7oUWvHPHz8NvYXgbWV6WmA5XdfF+5xeBvOLxM1o 5P5KwFTeIGyjf2OL+n9Tyo4QFBCOJtTSWoxFUGmNh1jt0pewAez9ht5TK90tFmU= X-Google-Smtp-Source: AGHT+IEBS50qCT4ruxHdXkECTEh7Ax2ViAaVEYyLvLMv58fmQUNh0yN1N5fRK0xwJ1K7O01kbvMxaA== X-Received: by 2002:a17:90b:364e:b0:28e:77e9:a2c6 with SMTP id nh14-20020a17090b364e00b0028e77e9a2c6mr263982pjb.8.1705460074564; Tue, 16 Jan 2024 18:54:34 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id rs3-20020a17090b2b8300b0028ceafb9124sm12553531pjb.51.2024.01.16.18.54.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jan 2024 18:54:34 -0800 (PST) From: Charlie Jenkins Date: Tue, 16 Jan 2024 18:54:28 -0800 Subject: [PATCH v8 1/2] riscv: Include riscv_set_icache_flush_ctx prctl MIME-Version: 1.0 Message-Id: <20240116-fencei-v8-1-43a42134f021@rivosinc.com> References: <20240116-fencei-v8-0-43a42134f021@rivosinc.com> In-Reply-To: <20240116-fencei-v8-0-43a42134f021@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=1705460071; l=10421; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=mgy6O5rEhKGg7VrqcW+OTuE294+Fj/DPTOuNQ5LDZKo=; b=2phiO4FMl4Q2SnYH0vSakc8F62iscwqqQKDd/yaLNuBXqhdMo3+eUAcXKq0LSRCYlAaRtzab/ YBH/XbN8bVZB+UF9qHho6tnj6am0arSb/oeqRPJCS033QJW9Yxw/O1z 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-20240116_185441_212067_0ACAC3BC X-CRM114-Status: GOOD ( 24.16 ) 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 | 4 +++ arch/riscv/include/asm/mmu_context.h | 3 ++ arch/riscv/include/asm/processor.h | 7 ++++ arch/riscv/include/asm/switch_to.h | 17 +++++++++ arch/riscv/mm/cacheflush.c | 67 ++++++++++++++++++++++++++++++++++++ arch/riscv/mm/context.c | 14 ++++++-- include/uapi/linux/prctl.h | 6 ++++ kernel/sys.c | 6 ++++ 8 files changed, 121 insertions(+), 3 deletions(-) diff --git a/arch/riscv/include/asm/mmu.h b/arch/riscv/include/asm/mmu.h index 355504b37f8e..f437b9a7f5b3 100644 --- a/arch/riscv/include/asm/mmu.h +++ b/arch/riscv/include/asm/mmu.h @@ -19,6 +19,10 @@ 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; + /* The most recent cpu a thread in this mm has been migrated to. */ + unsigned int prev_cpu; #endif #ifdef CONFIG_BINFMT_ELF_FDPIC unsigned long exec_fdpic_loadmap; diff --git a/arch/riscv/include/asm/mmu_context.h b/arch/riscv/include/asm/mmu_context.h index 7030837adc1a..195a2e90f3f9 100644 --- a/arch/riscv/include/asm/mmu_context.h +++ b/arch/riscv/include/asm/mmu_context.h @@ -29,6 +29,9 @@ static inline int init_new_context(struct task_struct *tsk, { #ifdef CONFIG_MMU atomic_long_set(&mm->context.id, 0); +#endif +#ifdef CONFIG_SMP + mm->context.prev_cpu = tsk->thread.prev_cpu; #endif return 0; } diff --git a/arch/riscv/include/asm/processor.h b/arch/riscv/include/asm/processor.h index f19f861cda54..1cad05f579ad 100644 --- a/arch/riscv/include/asm/processor.h +++ b/arch/riscv/include/asm/processor.h @@ -84,6 +84,10 @@ struct thread_struct { unsigned long vstate_ctrl; struct __riscv_v_ext_state vstate; unsigned long align_ctl; +#ifdef CONFIG_SMP + bool force_icache_flush; + unsigned int prev_cpu; +#endif }; /* Whitelist the fstate from the task_struct for hardened usercopy */ @@ -145,6 +149,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/include/asm/switch_to.h b/arch/riscv/include/asm/switch_to.h index f90d8e42f3c7..6a94431dc193 100644 --- a/arch/riscv/include/asm/switch_to.h +++ b/arch/riscv/include/asm/switch_to.h @@ -8,6 +8,7 @@ #include #include +#include #include #include #include @@ -73,6 +74,17 @@ static __always_inline bool has_fpu(void) { return false; } extern struct task_struct *__switch_to(struct task_struct *, struct task_struct *); +static inline bool switch_to_should_flush_icache(struct task_struct *task) +{ + unsigned int cpu = smp_processor_id(); + bool stale_mm = task->mm && (task->mm->context.force_icache_flush && + (cpu != task->mm->context.prev_cpu)); + bool stale_thread = task->thread.force_icache_flush && + (cpu != task->thread.prev_cpu); + + return stale_mm || stale_thread; +} + #define switch_to(prev, next, last) \ do { \ struct task_struct *__prev = (prev); \ @@ -81,7 +93,12 @@ do { \ __switch_to_fpu(__prev, __next); \ if (has_vector()) \ __switch_to_vector(__prev, __next); \ + if (switch_to_should_flush_icache(__next)) \ + local_flush_icache_all(); \ ((last) = __switch_to(__prev, __next)); \ + __next->thread.prev_cpu = smp_processor_id(); \ + if (__next->mm) \ + __next->mm->context.prev_cpu = smp_processor_id(); \ } while (0) #endif /* _ASM_RISCV_SWITCH_TO_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..b059dc0fae91 100644 --- a/arch/riscv/mm/context.c +++ b/arch/riscv/mm/context.c @@ -15,6 +15,7 @@ #include #include #include +#include #ifdef CONFIG_MMU @@ -297,19 +298,26 @@ 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)) { cpumask_clear_cpu(cpu, mask); + /* * Ensure the remote hart's writes are visible to this hart. * This pairs with a barrier in flush_icache_mm. */ smp_mb(); - local_flush_icache_all(); + + /* + * If cache will be flushed in switch_to, no need to flush here. + */ + if (!(task && switch_to_should_flush_icache(task))) + local_flush_icache_all(); } #endif @@ -332,5 +340,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 Wed Jan 17 02:54:29 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 13521377 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 86A3CC47077 for ; Wed, 17 Jan 2024 02:55:48 +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=1rr+xfKan5UwzQC2STyx9pwjFp4K6oOjReTICg0fnHs=; b=dcCCKTbxbNtg5x FAq46igp0w8kUy2S2+UAM2+GLZ/4v0mEC1f3GCUo3yMvr1jdK9y5VfzdyejeXvkdhiDxNDGnZiVkD rSrBIsprlDfajjpslH04yxi8XJwj5Lgh8XTCH8xd6tJ94PC3kIoeFTZ+IaeJS1JH4as3un0EHfM39 l/Jvac7RuFRWKv/CPecoCBTmyX+49sdDWU8ie6u2M94dAVEhaqD3e9IzK15nZpjmaY/zHd5CsmqG4 i8nRk2waa2FfrhRSPNh2zjEHrxPbZH6Jnv14RHbJwF1ZrO3JpY2CmRLtJMClzYNU2VLlBSpKCi769 FyUeAmtlVsRMD9MAvkbg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rPw5d-00EGYK-1Y; Wed, 17 Jan 2024 02:55:41 +0000 Received: from mail-oo1-f49.google.com ([209.85.161.49]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rPw5a-00EGXG-1l for linux-riscv@lists.infradead.org; Wed, 17 Jan 2024 02:55:40 +0000 Received: by mail-oo1-f49.google.com with SMTP id 006d021491bc7-598ee012192so1323737eaf.1 for ; Tue, 16 Jan 2024 18:55:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1705460076; x=1706064876; 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=NPwaFGwJVXA165SJk4N6+fNaFaLuOX6/L3PIB61yMHc=; b=gYRxusqFPXiuyrBxe55ImWtPMiwkHFJZPRi57GTfnBILCji4IcVcweePUOXeAkJ6+T AxYnYvEsYBHKrLhLDkrpwCvANbczeWhtdOsgXxJHjK3xed9+6O24CulEVdfYwkwHDL9o L31Pdu+caGB0/4B4wCQ0NiMimpU+KSMyR8/ZRqOgbEwC2qhNw1amXuIXYlI1/ugKLIs7 OQlOyuIsxwphfOJsawL3XQ0yTeVchhM8UCMUxT+kSwOrcyAz5CP+gQT5Qtx8n0K3FDtu lFwpAnbPMxYNY3G4h+KqRN0TeKd1etQNd23Zh9WO36zCus/IMnG6W8oxH7B5tTSlw21L WPPw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705460076; x=1706064876; 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=NPwaFGwJVXA165SJk4N6+fNaFaLuOX6/L3PIB61yMHc=; b=BANZEmuFyAbeTyb+uqz99IOXxVcW/htx3NPCN52fdokjfVAPbu8HEdoPPQChE8cSxO VhqkXbBYz7CjvTXfTbUmG1hIXciy/UwwVaGQpDAkBWuvO/scsesxlx3hEV3uXy4kVkNx BI7jmEFIep3NpHqBEqn3o6MrIHyzk+CHsQKvBHyFyOG40h4KOa001p4QU+dpC0rCd+ej CfptiP01G2HscGXisd5JmSgjj0JyVlZZ5Le/2SZG7BLjIDA71cItvZ24wUWDG8RCWRpz /u2b+9Oaz9RXjLsddLJrq25nbSBVqpdYZtJ/Z2QEitH/bg/ANATJFm3CsXttFhuhkudo l3vA== X-Gm-Message-State: AOJu0YzMYLjEOE3HHyPH3TQ5pAIqdonmoHa84ztCqR42r/3GYpRZy8yI Hrmbf77nNHNp4CA2iEiglki0DWGKuCg9OA== X-Google-Smtp-Source: AGHT+IG2W5nPmvH97IYcBVmrar6/f8At+4QvMr2HN81HHi6oDtpjNgquXeD30yYSxkgGR4doQp09Mg== X-Received: by 2002:a05:6358:6f97:b0:175:c1b8:1e93 with SMTP id s23-20020a0563586f9700b00175c1b81e93mr5383301rwn.65.1705460075911; Tue, 16 Jan 2024 18:54:35 -0800 (PST) Received: from charlie.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id rs3-20020a17090b2b8300b0028ceafb9124sm12553531pjb.51.2024.01.16.18.54.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jan 2024 18:54:35 -0800 (PST) From: Charlie Jenkins Date: Tue, 16 Jan 2024 18:54:29 -0800 Subject: [PATCH v8 2/2] documentation: Document PR_RISCV_SET_ICACHE_FLUSH_CTX prctl MIME-Version: 1.0 Message-Id: <20240116-fencei-v8-2-43a42134f021@rivosinc.com> References: <20240116-fencei-v8-0-43a42134f021@rivosinc.com> In-Reply-To: <20240116-fencei-v8-0-43a42134f021@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=1705460071; l=4373; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=W93XdAKoPAXGIl+AWcM9T4XvazvSTl8o1IPN58ULAuE=; b=mbioW8hvb+fc9oAM1jsn3rFvzBIpUD5yFkmi25h07vFpa3+q1T19t+fxT6l+efMBjrYBI1ITp tzlAD9RklowD4E8uQqqmi0BM0GIZPSycHn6ejOQ4/T4iiEDD5FG76Ug 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-20240116_185538_588389_FB9153DF X-CRM114-Status: GOOD ( 20.13 ) 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 | 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