Move virtual region creation from Zephyr to SOF, add virtual memory regions protection #10124

marcinszkudlinski · 2025-07-18T13:09:38Z

This PR moves creation of virtual memory regions from Zephyr to SOF. ZEphyr is still keeping a table with regions and ensures no regions overlapping

it also creates a new region for loadable modules.
FUTURE: add checking if a module being loaded fits into the region

it is also a fix for viretual memory overlaps - when a platform had 5 cores (PTL) the shared memory regions overlaps witj loadable modules area

this PR must be mergerd after zephyrproject-rtos/zephyr#93334

Copilot

Pull Request Overview

This PR introduces virtual memory regions for the SOF (Sound Open Firmware) project, specifically adding support for two types of virtual regions: shared heap regions and loadable library regions. The changes establish a new attribute-based system for categorizing memory regions and implement initialization code for both virtual heap and loadable library memory regions.

Key changes:

Introduces new virtual region attribute constants to replace hardcoded values
Adds virtual memory region initialization for both shared heap and loadable libraries
Updates board configurations to support multiple virtual regions

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
zephyr/include/sof/lib/regions_mm.h	Defines new virtual region attribute constants
zephyr/lib/regions_mm.c	Updates region matching to use new attribute constant
zephyr/lib/alloc.c	Adds virtual memory region initialization for shared heap
src/library_manager/llext_manager_dram.c	Implements virtual region initialization for loadable libraries
zephyr/Kconfig	Adds configuration for virtual heap region size
src/library_manager/Kconfig	Adds configuration for library region size
app/boards/*.conf	Updates board configurations to support 2 virtual regions

Comments suppressed due to low confidence (1)

Copilot · 2025-07-18T13:09:57Z

src/library_manager/Kconfig

 	  should be set by this option.

+config LIBRARY_REGION_SIZE
+	hex "Base address for memory, dedicated to loadable modules"


The description is incorrect - this config defines the size of the region, not the base address. It should read 'Size of memory region dedicated to loadable modules'.

Suggested change

hex "Base address for memory, dedicated to loadable modules"

hex "Size of memory region dedicated to loadable modules"

lgirdwood

LGTM, just needs the base address/size Kconfig fixes as per copilot.

lyakh · 2025-07-31T14:30:57Z

src/library_manager/llext_manager.c

+	/* add a region for loadable libraries */
+	ret = adsp_add_virtual_memory_region(CONFIG_LIBRARY_BASE_ADDRESS,
+					     CONFIG_LIBRARY_REGION_SIZE,
+					     VIRTUAL_REGION_LLEXT_LIBRARIES_ATTR);


return adsp_add_virtual_memory_region(...);;-)

lgirdwood · 2025-07-31T15:32:43Z

@marcinszkudlinski some CI build error

marcinszkudlinski · 2025-08-01T06:12:18Z

@marcinszkudlinski some CI build error

yep, Zephyr PR must go first

marcinszkudlinski · 2025-08-13T08:41:22Z

(rebase only)

marcinszkudlinski · 2025-08-13T09:03:32Z

zephyr with required change

lgirdwood · 2025-08-13T15:55:01Z

@marcinszkudlinski looks like we are blocked on the west update atm as its failing fuzzer. @serhiy-katsyuba-intel is bisecting which Zephyr commit breaks. Btw, can you check internal CI. Thanks!

lyakh · 2025-08-14T09:03:37Z

west.yml

    - name: zephyr
      repo-path: zephyr
-      revision: c99605126cd9cce5684ddd9ad56aed5292004867
+      revision: 8843fd9fe1800164fbb5221d95d1eba7d0699458


isn't this breaking bisection? If so, it should be merged with the changes that switch SOF over to the new API

jsarha

AFAIU LGTM

kv2019i

@marcinszkudlinski can you check this is bisect safe w.r.t. zephyr update?

kv2019i · 2025-08-14T12:30:31Z

west.yml

      repo-path: tomlc99
      path: sof/tools/rimage/tomlc99
      revision: e3a03f5ec7d8d33be705c5ce8a632d998ce9b4d1



This could have the usual commit style for west.yml updates.

kv2019i · 2025-08-14T12:31:55Z

src/library_manager/llext_manager.c

 #include <rimage/sof/user/manifest.h>
 #include <module/module/api_ver.h>

+#include <adsp_memory_regions.h>


I think the west update needs to come before this, or bisect is broken.

so it does...

I think the west update needs to come before this, or bisect is broken.

@kv2019i I think it's the opposite - moving to the new Zephyr option without updating SOF to it seems to break bisection to me #10124 (comment)

kv2019i

Style issue remains with the west.yml commit, but not a blocker, approving.

lyakh

bisection seems broken to me, please clarify

marcinszkudlinski · 2025-08-18T10:15:22Z

@lyakh bisect is fine
the very first commit switches Zephyr to new version
That was the whole point of WA I put in SOF - to solve circular dependency SOF-Zephyr
at moment of zephyr's SHA is changed, the __weak marked functions from SOF will be replaced by new Zephyr's

Calling of the functions in question (adsp_add_virtual_memory_region and adsp_mm_get_unused_l2_start_aligned) is already in place, it just do nothing because creation of regions used to be hard-coded in Zephyr.

Following commits remove the WA and make use of new Zephyr's features.

lyakh · 2025-08-18T12:09:19Z

Calling of the functions in question (adsp_add_virtual_memory_region and adsp_mm_get_unused_l2_start_aligned) is already in place, it just do nothing because creation of regions used to be hard-coded in Zephyr.

@marcinszkudlinski aha, thanks, and it also works before the fourth commit in your PR? 0a5d62e

marcinszkudlinski · 2025-08-18T12:20:31Z

yes, it will. default MM_DRV_INTEL_VIRTUAL_REGION_COUNT=1 so a single region will be created

marcinszkudlinski · 2025-08-18T12:35:54Z

internal CI: couple of ADSP_IPC_MOD_NOT_INITIALIZED, checking...

question resolved, waiting for CI results

marcinszkudlinski · 2025-08-20T11:17:52Z

if a module had no .bss + .data region there llext loaded still was trying to do mapping for virtual address = 0 and size = 0.
Virtual region protection introduced in this PR was rejecting such call causing the whole module load process failure

FIX: Condition added

Update to Zephyr commit 8843fd9fe18 Samples: Fix ID for VCNL4040 sensor sample Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

remove all workarounds for virtual memory region creation: - stubs for zephyr functions - using first memory region without checking attributes Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

Add a _safe check, verify if virtual memory being mapped for virtual heap fits into the region it belongs Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

This commit adds initialization of virtual memory region dedicated for LLEXT loadable modules. Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

Add a _safe check, verify if virtual memory being mapped for LLEXT module fits into the region it belongs Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

marcinszkudlinski · 2025-08-21T10:17:09Z

cosmetic: extra empty line removed, zephyr update commit description changed

Copilot AI review requested due to automatic review settings July 18, 2025 13:09

marcinszkudlinski requested review from abonislawski, dabekjakub, dbaluta, iuliana-prodan, kv2019i, lbetlej, lgirdwood, lyakh, mmaka1 and plbossart as code owners July 18, 2025 13:09

Copilot AI reviewed Jul 18, 2025

View reviewed changes

marcinszkudlinski changed the title ~~Virt regions~~ Move virtual region creation from Zephyr to SOF Jul 18, 2025

lgirdwood reviewed Jul 21, 2025

View reviewed changes

marcinszkudlinski force-pushed the virt_regions branch from 9f34d35 to ccaa42f Compare July 31, 2025 14:03

marcinszkudlinski changed the title ~~Move virtual region creation from Zephyr to SOF~~ Move virtual region creation from Zephyr to SOF, add virtual memory regions protection Jul 31, 2025

lyakh reviewed Jul 31, 2025

View reviewed changes

lgirdwood approved these changes Jul 31, 2025

View reviewed changes

marcinszkudlinski force-pushed the virt_regions branch from ccaa42f to da254f5 Compare August 13, 2025 08:41

marcinszkudlinski force-pushed the virt_regions branch from da254f5 to 98701fc Compare August 13, 2025 08:55

lyakh reviewed Aug 14, 2025

View reviewed changes

jsarha approved these changes Aug 14, 2025

View reviewed changes

kv2019i requested changes Aug 14, 2025

View reviewed changes

kv2019i approved these changes Aug 15, 2025

View reviewed changes

lyakh previously requested changes Aug 18, 2025

View reviewed changes

marcinszkudlinski force-pushed the virt_regions branch from 98701fc to 8e7191f Compare August 20, 2025 11:13

lyakh approved these changes Aug 21, 2025

View reviewed changes

marcinszkudlinski added 5 commits August 21, 2025 12:15

west.yml: update to current Zephyr

e738f1c

Update to Zephyr commit 8843fd9fe18 Samples: Fix ID for VCNL4040 sensor sample Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

mem: remove virtual memory regions workarounds

81837be

remove all workarounds for virtual memory region creation: - stubs for zephyr functions - using first memory region without checking attributes Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

mem: add check if region being mapped fits into virtual mem region

9578375

Add a _safe check, verify if virtual memory being mapped for virtual heap fits into the region it belongs Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

mem: add initialization of virt memory region for LLEXT modules

6bd7a05

This commit adds initialization of virtual memory region dedicated for LLEXT loadable modules. Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

mem: add check if region being mapped fits into LLEXT mem region

6cdf069

Add a _safe check, verify if virtual memory being mapped for LLEXT module fits into the region it belongs Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

marcinszkudlinski force-pushed the virt_regions branch from 8e7191f to 6cdf069 Compare August 21, 2025 10:16

kv2019i merged commit 28a99f1 into thesofproject:main Aug 22, 2025
36 of 45 checks passed

tmleman mentioned this pull request Aug 26, 2025

intel: Introduce NVL and NVL-S platforms #10156

Merged

	hex "Base address for memory, dedicated to loadable modules"
	hex "Size of memory region dedicated to loadable modules"

Move virtual region creation from Zephyr to SOF, add virtual memory regions protection #10124

Move virtual region creation from Zephyr to SOF, add virtual memory regions protection #10124

Uh oh!

Conversation

marcinszkudlinski commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

lgirdwood left a comment

Choose a reason for hiding this comment

Uh oh!

lyakh Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

lgirdwood commented Jul 31, 2025

Uh oh!

marcinszkudlinski commented Aug 1, 2025

Uh oh!

marcinszkudlinski commented Aug 13, 2025

Uh oh!

marcinszkudlinski commented Aug 13, 2025

Uh oh!

lgirdwood commented Aug 13, 2025

Uh oh!

lyakh Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

jsarha left a comment

Choose a reason for hiding this comment

Uh oh!

kv2019i left a comment

Choose a reason for hiding this comment

Uh oh!

kv2019i Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

kv2019i Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

marcinszkudlinski Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

lyakh Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

kv2019i left a comment

Choose a reason for hiding this comment

Uh oh!

lyakh left a comment

Choose a reason for hiding this comment

Uh oh!

marcinszkudlinski commented Aug 18, 2025

Uh oh!

lyakh commented Aug 18, 2025

Uh oh!

marcinszkudlinski commented Aug 18, 2025

Uh oh!

marcinszkudlinski commented Aug 18, 2025

Uh oh!

marcinszkudlinski commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marcinszkudlinski commented Aug 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

marcinszkudlinski commented Jul 18, 2025 •

edited

Loading

marcinszkudlinski commented Aug 20, 2025 •

edited

Loading