Skip to content

Major rewrite #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
kr-t merged 234 commits into from
Jan 13, 2026
Merged

Major rewrite #116

kr-t merged 234 commits into from
Jan 13, 2026

Conversation

@casaroli
Copy link
Contributor

@casaroli casaroli commented Jan 7, 2026 •
edited
Loading

Description

Happy new year!

This is a major rewrite of Ocre. I am sorry for the massive PR. The main objectives were:

  • Decouple Ocre from the runtime engine
  • Simplify management of container features (capabilities)
  • Simplify the Ocre APIs
  • Fix as many issues as possible

I believe this rework will make Ocre better and safer, and it will also simplify the functionality we will want to add to Ocre in the future.

Some of the changes are listed below:

  • New thread-safe synchronous API (contexts, containers)
  • New interface for defining additional runtime engines
  • New interface for container features (capabilities)
  • Container lifecycle management functionality (exit status, wait)
  • Reworked build system
  • Uses only POSIX APIs available in most RTOS (pthreads, mutex, file, etc)
  • Targets Zephyr 4.3
  • Improvements to ocre-cli (image and container management)
  • Cleaner platform abstraction layer
  • Added tests, leak checks and source code coverage generation

Fixes:

Known issues

There are a few known issues that I plan on fixing in the near future after/if this gets accepted and merged.

  • ocre_gpio and ocre_sensor are probably broken
  • missing documentation
  • missing u585 CI build
  • missing nrf5340

Please, feel free to add any comments or questions. You are welcome to join our Slack server if you are looking for a warmer discussion. 😅

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code cleanup/refactoring
  • This change requires a documentation update
  • CI system update
  • Test Coverage update

How Has This Been Tested?

There are tests in the CI

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@casaroli casaroli requested review from kr-t and srberard as code owners January 7, 2026 09:52
@kr-t
Copy link
Collaborator

kr-t commented Jan 7, 2026

When it's merged, we are going to create issues right away to track missing (and, perhaps, new) features; additionally, legacy branch will be created to keep stable Ocre alive for a while, to give everyone time to get used to this new refactoring.

@kr-t
Copy link
Collaborator

kr-t commented Jan 7, 2026

Legacy branch is now protected (like the main) and can be found here: https://github.com/project-ocre/ocre-runtime/tree/legacy

@casaroli casaroli force-pushed the rework branch 3 times, most recently from fcb5fa9 to 47fbe91 Compare January 7, 2026 10:35
casaroli and others added 23 commits January 7, 2026 12:00
@casaroli
Revert "Minor fix on GPIO initialization (#113)"
5bc126e 
This reverts commit fbce6c2.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Prevent slow-to-start containers from trying to run in the sa…
c274807 
…me slot (#114)"

This reverts commit 90cb917.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "tests: Add initial test case for Modbus Server Container (#108)"
7e1b206 
This reverts commit 533f2f5.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "tests: add external memory erase step for b_u585 board (#109)"
e2e8d31 
This reverts commit 314a647.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Improve formatting (#107)"
5a3ea62 
This reverts commit 0ba75c1.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Add lint support (#106)"
512e1fe 
This reverts commit 4b15a2e.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Enable AoT and fix ISA guess (#105)"
933d2b2 
This reverts commit 7494611.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Add exception handling (#104)"
6d88562 
This reverts commit cafad42.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Add RT1064 GPIO config (#103)"
d2731a2 
This reverts commit e9d8d04.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Ocre containers: Adding support for NRF5340-DK board (#93)"
b9a32d7 
This reverts commit 4778e5c.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "Add shared memory and DNS resolution support (#99)"
c1c76ad 
This reverts commit f555f1b.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "const sample container (#101)"
2aa1af0 
This reverts commit 6c98588.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Revert "fix(sample_container): truncate file (#100)"
79cf1cf 
This reverts commit 734ed5c.

This commit is kept in the legacy branch.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(ocre): introduce user heap
5f96834 
the user_malloc and user_free functions will be used on platforms
with support for external PSRAM. This way we can differentiate
allocations in the internal or external RAM.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(zephyr): use shared multi heap for user heap
9719d84 
These functions allocate memory on external PSRAM on boards that
have CONFIG_SHARED_MULTI_HEAP enabled.

Otherwise, they work just like core_malloc and core_free.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(posix): dummy user heap wrapper
85906d0 
On systems with a single heap, these functions work exactly the
same as malloc and free.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(fs): load wasm module in user heap
2d84046 
The user heap is user for large objects.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(zephyr): realloc stub
7d22e78 
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(wamr): use user heap
7b96301 
Use the user heap for wamr and related container memory.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
ocre_mem: remove storage allocator
4b1ee95 
In favor of the user heap mechanism.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
wamr: remove OCRE_WAMR_HEAP_BUFFER_SIZE
5125233 
We now use the user heap mechanism.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@kr-t @casaroli
Add shared memory and DNS resolution support (#99)
a788d12 
Update wamr's hash to support networking DNS changes.

---------

Signed-off-by: Krisztian Szilvasi <34309983+kr-t@users.noreply.github.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
build(devcontainer): Dockerfile
96e6456 
This docker image will be used in the CI and the devcontainer.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
Copy link
Contributor Author

casaroli commented Jan 8, 2026

I spent a couple of hours but just reviewed like 25% of this massive PR. Will continue on the following days, just have minor comments for now.

Thank you very much for your inputs. I fixed the typos and answered some of the questions.

Looking forward to your next comments.

@casaroli
chore: remove spurious file
860c94b 
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@kr-t
Copy link
Collaborator

kr-t commented Jan 8, 2026

closes #80

@kr-t
Copy link
Collaborator

kr-t commented Jan 8, 2026

Closes #115

@kr-t
Copy link
Collaborator

kr-t commented Jan 8, 2026

Closes #92

@kr-t
Copy link
Collaborator

kr-t commented Jan 8, 2026

Closes #94

@kr-t
Copy link
Collaborator

kr-t commented Jan 8, 2026

Closes #33

kr-t
kr-t reviewed Jan 8, 2026
View reviewed changes
zephyr/wamr.cmake
# SPDX-License-Identifier: Apache-2.0

# Determine the ISA of the target and set appropriately
if (DEFINED CONFIG_ISA_THUMB2)
Copy link
Collaborator

@kr-t kr-t Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ISA determination shall be modified as in this commit: 7494611
Without this, Cortex boards won't be configured to THUMBV8M (our U585 board) and AoT won't be working correctly.

Copy link
Contributor Author

@casaroli casaroli Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. but I used more robust Zephyr config variables instead.

kr-t
kr-t reviewed Jan 8, 2026
View reviewed changes
cmake/wamr.cmake
Copy link
Collaborator

@kr-t kr-t Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the future - we might want to rethink how we group files:
earlier we had posix folder for posix build scripts, and zephyr for zephyr ones. Now we still have zephyr folder for zephyr ones, but the posix files are just all around - like here, in system/posix, in main Cmake file. This might be hard to maintain for new users without the repo knowledge.

Copy link
Contributor Author

@casaroli casaroli Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this directory is for general cmake files (to be included in CMakeLists.txt) not specific for Zephyr or Linux, however with this specific file I still could not get it to work with Zephyr (just requires more work) and I hope in the near future we can have a single cmake (this one) for wamr in both platforms.

Now, we could have this file somewhere else, but we will eventually move it back here when we get the consistent implementation.

I suggest we keep it like this for this merge and then figure out what to in the future.

Copy link
Collaborator

@kr-t kr-t Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I accept and agree w your suggestion.

@casaroli
Copy link
Contributor Author

casaroli commented Jan 8, 2026

Closes #33

*** Partially fixes #33

@casaroli
Copy link
Contributor Author

casaroli commented Jan 8, 2026

Closes #92

We did not delete this file. Should I?

@kr-t
Copy link
Collaborator

kr-t commented Jan 8, 2026

Closes #92

We did not delete this file. Should I?

oh. yes, please. this is obsolete.

@casaroli
chore(ocre_api): remove obsolete file
a1c5ffe 
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
fix(zephyr): selection of WAMR architecture
1d06b9f 
Fix the selection of the WAMR architecture based on
more robust Zephyr configuration variables.

This enables proper support for ARM M33+ boards.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
kr-t
kr-t reviewed Jan 9, 2026
View reviewed changes
README.md
```sh
pip install -r zephyr/scripts/requirements.txt
cd ~/zephyrproject
west init -m https://github.com/ocre-project/ocre.git
Copy link
Collaborator

@kr-t kr-t Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong command - proper one:
west init -m https://github.com/project-ocre/ocre-runtime.git

kr-t
kr-t reviewed Jan 9, 2026
View reviewed changes
README.md
```sh
git clone git@github.com:project-ocre/ocre-runtime.git
cd ocre-runtime
west build -p always -b b_u585i_iot02a ocre-runtime/src/samples/demo/zephyr
Copy link
Collaborator

@kr-t kr-t Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, init command above will clone ocre in the default folder above called /application. We shall either change the path then here, or above init it w the proper dir name

kr-t
kr-t reviewed Jan 9, 2026
View reviewed changes
README.md
Copy link
Collaborator

@kr-t kr-t Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing info to clone submodules

@kr-t
Copy link
Collaborator

kr-t commented Jan 9, 2026

The PR in its current state look good to be merged; it is hard continuing working on some missing stuff, and the solution is to merge it as it is, and start fixing/adding stuff on the new state. It will give a possibility for other contributors to work on it. As mentioned before, legacy branch still contains the previous, stable Ocre-Runtime. That shall be used in stable environments for next few weeks.

Following PR notes were discussed and found w @casaroli beside his findings above. Proper GitHub issues will be created for anyone to work on these.

Missing or regressed features

  • Build script removed compared to previous releases.
  • U585 sample configs incomplete; samples cannot be built or tested without manual menuconfig work.
  • POSIX demos fail when run outside their directory because containers are not packaged with the app - accepted this way, but documentation shall explain this.
  • POSIX lost the ability to run arbitrary containers passed as arguments - this will be added in "Posix Supervisor" application.
  • Zephyr supervisor demo supports flashing arbitrary containers, but the commands are undocumented.
  • No CI coverage for U585.
  • The samples have not been systematically tested, so we do not know which ones currently work. This should be resolved with proper tests.
  • native_sim 32‑bit target misconfigured and missing from CI.
  • README contains outdated paths, and missing submodule instructions.

Miscellaneous

  • tests_hw should eventually be merged into tests/.
  • CI job names should distinguish between “build” and “build-and-run” to make behavior clear.
  • native_sim64 is not tested beside mini sample. demo is not working due to filesystem merge issues.
    Documentation
  • Add a sample or documentation section on customizing the runtime engine in OCRE.

@casaroli
feat(wamr): rename to wamr/wasip1
0628ac3 
To be more explicit about the environment, as we will have other
WAMR based non-wasi engines also in the future.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli
feat(container): allow NULL runtime engine
42243b1 
In case the user passes a NULL runtime engine, we should try to
figure out the correct one, automatically.

In the future, we will read this from the container manifest, and
let the user override it, however for now, we just use wamr/wasip1
as the "default".

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
This was referenced Jan 9, 2026
Open
Closed
srberard
srberard approved these changes Jan 12, 2026
View reviewed changes
Copy link
Collaborator

@srberard srberard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just make sure to validate source headers for appropriate copyright and attribution in the README.

@kr-t kr-t merged commit 42243b1 into main Jan 13, 2026
13 checks passed
@kr-t kr-t deleted the rework branch January 13, 2026 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@srberard srberard srberard approved these changes

@kr-t kr-t kr-t approved these changes

+1 more reviewer

@fgr-17 fgr-17 fgr-17 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@casaroli @kr-t @srberard @fgr-17 @SorinOlari