From patchwork Tue Jan 23 23:29:51 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Jenkins X-Patchwork-Id: 13528276 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 0B516C47DDC for ; Tue, 23 Jan 2024 23:31:43 +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=bEE+SpFMFkn7zfDXypn2NsbKxBUJVSO+9lIpmR6FY+M=; b=Dmh94oHOW9b1QB EzW+iJKtWOUszEFeugu/GP5t1GDdwqNphGB1c+0Rq9hrINSYIa8YxV9muxRI2XStWLC/fX47SHaQS m42iFfysE6e3LfjieM/oDMWOv2SO4SkhfnpY83attsuvtiJDCQQ6O7NkeNv4e8p3mtbUsxvs2d8pW wc5Nrt7Jl5udJXA/847xGCIKSWGQLgdAKAxRtJmdh2nSU4ewr1c2HOZjz4NAXuDYWc5b1w0DTS8YS lori25HnwYcrXfrfmY9c+g9vKUknskwTUTNZMYKr1KrZCA4THaK8CpcT3EcMIbAaw3wPc0CX1asU3 eOhPfeaIFxlQzxYM3sLg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rSQEp-000pdq-19; Tue, 23 Jan 2024 23:31:27 +0000 Received: from mail-pj1-x102e.google.com ([2607:f8b0:4864:20::102e]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rSQEl-000paZ-1j for linux-riscv@lists.infradead.org; Tue, 23 Jan 2024 23:31:25 +0000 Received: by mail-pj1-x102e.google.com with SMTP id 98e67ed59e1d1-290449c30d4so2183896a91.2 for ; Tue, 23 Jan 2024 15:31:23 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1706052683; x=1706657483; 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=MFBy5Jhev5nWWdDTHxl/l5SJEKa5TSeb5KKT2dQQAj4=; b=KQSTrM32z9aMXYJ/l3S9vcJ9wyeZ+KbtAPqJEkn+ELsw6npAidAayvAQMgAiG7dEXU rCSrm0YlUX52eC9rfDzidsXCiaNH4Y5GQjtpc6hhiTAu8Fki466Y0E5veEBM18k4myvP dhlGwaDvwRrI2kc6myqBS9p/jnP3hsuBCUFaOSlprRBFHabS3gwpHBEqOyIE6ZRyqyXl qSCxHBTc2et/GKeF5Sn+7RJagvCjobrZXGgZr9q++jw/kQC+bPk6X5loPq1y5na/et1B lR5AmOXZdF+D/Pzdlip+w+gQ4Ma0CLZg6P7XAwFN897JNOkWzQZyTErc3C9/rmrdvWMu VQbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706052683; x=1706657483; 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=MFBy5Jhev5nWWdDTHxl/l5SJEKa5TSeb5KKT2dQQAj4=; b=snuWUnJq154KUgMxd/TaUdF3q+xmkH+w7N/7oWGfDaeVDRWJUYJmfo6mYPFpj7H5Kv vR9cFhdz+esOfxdxX1flALyMA0ckEbIb9EFG8AnUQmxUtBtoh1l7NWZPcm/SCqYtLHQI eVEMXMV+TdDPFN+WtL3PtRQlCnqGlhcBfpTs4eiM3b4uAWUgT2aObtVpq7xqpTKPiXzX ckV14LhOc7FQd9Zr8b4jDJMivy99Zs9geihp6XlqO8DUssg9DphAsa16YNo7enI5R856 Mjb45TmmmAsImEK4Qaxfbk8NBRdFJWfaxuBgSvbWMVKNLzBr22pMmYNZesi7cu302NrS RTjQ== X-Gm-Message-State: AOJu0Yx6wAQ9FLqcAcdNnkWgljK7Ei2igGURZ8QW6hVZIcCNo77tw5bC jltjbYL86r/6oyBLvwzINR8bS4SePeF4YWHeQJZsFftOiTRaa2MG2MChOG23qLg= X-Google-Smtp-Source: AGHT+IEi37Pa/gG7czUf85R7YXWtq6tKYHXwQ5zNNZ7Tfn61NcbfM5AiSRDOlUtQgCW4kytOLIzsXQ== X-Received: by 2002:a17:90b:153:b0:28e:8c11:e042 with SMTP id em19-20020a17090b015300b0028e8c11e042mr3142760pjb.56.1706052682945; Tue, 23 Jan 2024 15:31:22 -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.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 15:31:22 -0800 (PST) From: Charlie Jenkins Date: Tue, 23 Jan 2024 15:29:51 -0800 Subject: [PATCH v9 1/2] riscv: Include riscv_set_icache_flush_ctx prctl MIME-Version: 1.0 Message-Id: <20240123-fencei-v9-1-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=9638; i=charlie@rivosinc.com; s=20231120; h=from:subject:message-id; bh=TgPJhtuS5elB9x3qkOYRijPzfqXeMZFnxGkigghx8VE=; b=H+VOHsPIUKHl1VzT+mYCChtEjWh5nkPnxepWSSs8XNMkqozEj3RkHTI/IFCW6O/cSWgzrAW2d rfDaQBhPCcuBkkcAm/i/+8HxKJM6aBTDA66Dh2ciyvJvLSerQheAyMo 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-20240123_153123_726996_2B95B3D4 X-CRM114-Status: GOOD ( 22.92 ) 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 | 7 ++++ arch/riscv/include/asm/switch_to.h | 13 ++++++++ arch/riscv/mm/cacheflush.c | 67 ++++++++++++++++++++++++++++++++++++++ arch/riscv/mm/context.c | 14 ++++++-- include/uapi/linux/prctl.h | 6 ++++ kernel/sys.c | 6 ++++ 7 files changed, 112 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..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..72c032d4277e 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,15 @@ 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) +{ + bool stale_mm = task->mm && (task->mm->context.force_icache_flush); + bool stale_thread = task->thread.force_icache_flush && + (smp_processor_id() != task->thread.prev_cpu); + + return stale_mm || stale_thread; +} + #define switch_to(prev, next, last) \ do { \ struct task_struct *__prev = (prev); \ @@ -81,7 +91,10 @@ 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(); \ } 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 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: 13528274 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 70328C47DDB for ; Tue, 23 Jan 2024 23:31:43 +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=t2Fmvn9mQCuqeCQOlHoS+io5UqjqhG+al6U7An50hwU=; b=2xYDUEHr1Nh9tH o7Khd5JQxp0QrrpKlKOA9My5AHYc2LL9H7fYtIV8wM/YXaB/4aIPEEHY3S4VQUd5dsSofOoTvk51n hiOwR+79scqv0RzLWqGwNP2UnPxQlFYUpm6fzLHlGjBDn9029XAHzKQZrkCvNJJY4gpsx+EjdUhMA dNqqhCzyi+E5tbUyTO4PYvOZOI8n1DmMPbcECUJ7wnckRwdFmlcd662tO0AlB0KGNCqYu6qJixpYD z8XKGKFvWTeb/R4AmEjVeEROwUg9RXthFoo6/UxwP6pgxVjeJv8oAlhyMxLa6nS5/sePNe4n6kV10 hfFZyQ42DJMEXUhdVmQQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rSQEs-000pes-16; Tue, 23 Jan 2024 23:31:30 +0000 Received: from mail-pj1-x1036.google.com ([2607:f8b0:4864:20::1036]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rSQEp-000pbx-08 for linux-riscv@lists.infradead.org; Tue, 23 Jan 2024 23:31:29 +0000 Received: by mail-pj1-x1036.google.com with SMTP id 98e67ed59e1d1-2906bd9f2ebso2391662a91.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=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=ypj/UfIhrHcfkXvw9Dauu4SlRhzY7WsoxY+bpEphFSM=; b=zajEK45d4BsEN9UABSJYeEIvPS5iePa63tQ0fW67P8s1ph6V3/aHAqdmgIsPVTSJZg 75U3Haa0t8OpwmKzkbjkEFv4QjjX5jW07b4aO8q+rDyrZKuEQpZ0HyBH+1yPg3Ee9zgW 9BoDfKKX4pgw1Skcd3UNfxCFst6OHaRWr1+HU1MO+nb+FfBj6AXW2UcDI+sbNYQaptMY aD3WHPgecD9nd0WIPg30jfE/puWUBQUN/viffQl+LFf+uG1McJLCx0Z+Qldp/vchoeOg kkFVfvwr7/7JoNxGVdQdR6xlVLMBlBrLJFWpVayx4z2KuTJRkZ2d6e73lR9aJfdjBXwG Roig== 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=N8lESZqUeVJg1IqG3H5N8KWYoBIDegt7g0gQccDytxnCDA4xfgKs57nrG8QF+48EUy 8FjqF7MOXxkBi0MLxvR/XaPxbXpR3hINR2xGoM8WMs0o2oQZo2S0GlNNvGgGNLQlUkur IfQJGlsU4n1dKKnNoWWWPd7av/6K7Ypf9VqJpykEipEYYDnxsAHlFrfrYay1/lPDJXWC IwgkbjO84wQGINgt+nXfqPRvHJgjzjMIkGdIvChs8W6fYMFeUBX5b3bQ7YBjYSKHAPnb mIyWbHd/P6f88sNthvSJwkVz3pn7XYQmSNZwS4eoYQssdxuytfAz0bEDSmpwFNoC9nwf Hnsw== X-Gm-Message-State: AOJu0YyJwgNd7EqfRV0r7oGV/MkzJ+pMQutwDhNFRh+nttN9zsCwZL34 cy/enZJzqZ0nrkbZbtXazPYv5MTTCMN4m/KzczXVsk7hpnRWTmtALSPBk+6zdwc= X-Google-Smtp-Source: AGHT+IHToLOk9K0v/hNzUDffZhy+RECx2WTKxjTAijS0JAdyRvVF5awESDE1uNYxsm2LWaQ36Vie/g== 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 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-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240123_153127_082135_9169EDB2 X-CRM114-Status: GOOD ( 19.84 ) 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