Update the o1heap submodule to 3.0.0
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- build-system, testing
Research direction
Start by comparing the o1heap pin in submodules/o1heap with CETL’s expected version in cetlvast/cmake/modules/ExternalDependenciesGitHub.cmake.in, then inspect verification/CMakeLists.txt and verification/cmake/modules/Findo1heap.cmake. Choose whether to pin 2.2.0 or 3.0.0, account for the 32-bit alignment change, and run the 40 workflows in verification/CMakePresets.json using the specified toolshed image. Done means the chosen pin is updated and all workflows pass; if choosing 3.0.0, file a CETL issue.
Written by the indexing model from the issue text.
Description
Summary
Update submodules/o1heap from its current pin, 10e2754 (2.1.1 plus one CI commit, April 2024), to the latest release, 3.0.0.
How Nunavut uses o1heap
Only the verification suite uses it. verification/CMakeLists.txt builds it as a static library (verification/cmake/modules/Findo1heap.cmake) and links it into every native C++ test and the MCU test (target_link_libraries(... PUBLIC o1heap)). No Nunavut source, template, or test calls an o1heap function, and no test includes CETL's cetl/pmr/o1heap_memory_resource_delegate.hpp.
What changed upstream
From the o1heap 3.0.0 changelog:
- v2.2: adds
o1heapMinArenaSize,o1heapGetMaxAllocationSize, and optional trace events (O1HEAP_TRACE). - v3.0 (major):
- Per-fragment overhead drops from 4× to 2× pointer width. On 32-bit targets,
O1HEAP_ALIGNMENTbecomes 8 bytes instead of 16. - Adds
o1heapReallocate. - Removes the v2.2 trace events.
- Per-fragment overhead drops from 4× to 2× pointer width. On 32-bit targets,
The rest of the public API (o1heapInit, o1heapAllocate, o1heapFree, o1heapDoInvariantsHold, o1heapGetDiagnostics) is unchanged.
Things to check
- CETL compatibility. CETL v2.1.0, which Nunavut now pins, tests against o1heap 2.2.0 (
cetlvast/cmake/modules/ExternalDependenciesGitHub.cmake.in). Itso1heap_memory_resource_delegate.hppcallso1heapMinArenaSizeando1heapGetMaxAllocationSize, which the current 2.1.1 pin doesn't have. That's harmless today only because Nunavut never includes that header. 3.0.0 has both functions, but CETL hasn't tested against it. The update should either:- stay at 2.2.0 to match CETL, or
- go to 3.0.0 and file a CETL issue so CETL tests 3.0.0 as well.
- 32-bit alignment. The
gcc-native32andgcc-arm-none-eabiflavours run on 32-bit targets, where 3.0 halves the alignment. Any test that assumes 16-byte alignment from o1heap would be affected. None are known to exist today.
Work
- Move
submodules/o1heapto the chosen tag. - Run all 40 verification workflows (
verification/CMakePresets.json) inghcr.io/opencyphal/toolshed:ts26.4.5and fix any regressions.
- Dominant language
- Python
- Stars
- 48
- Forks
- 26
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 9
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenCyphal/nunavut
-
build and test C++ dependencies
Difficulty 4/5 3-5 days Newbie friendliness 50/100
OpenCyphal/nunavut#418 ·
Maintainers usually reply within 1 day
-
build and test Python
Difficulty 4/5 3-5 days Newbie friendliness 45/100
OpenCyphal/nunavut#416 ·
Maintainers usually reply within 1 day
-
C C++ Python
Difficulty 4/5 3-5 days Newbie friendliness 52/100
OpenCyphal/nunavut#414 · 1 comment ·
Maintainers usually reply within 1 day
-
feature under consideration
Difficulty 5/5 Over a week Newbie friendliness 32/100
OpenCyphal/nunavut#413 ·
Maintainers usually reply within 1 day
-
Python
Difficulty 4/5 3-5 days Newbie friendliness 45/100
OpenCyphal/nunavut#412 ·
Maintainers usually reply within 1 day
All issues in OpenCyphal/nunavut
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
py-econometrics/pyfixest#2072 ·
Maintainers usually reply within 1 day
-
~planning docs
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainers usually reply within 1 day
-
Bosch Room Thermostat II number entities offer -500 to 3000 °C setpoint limits and a -32768 to 32767 °C outdoor temperaturePossibly taken @zigpy-review-bot claimed this today. Openbot: code audit
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zigpy/zha-device-handlers#5769 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 80/100
R0Y00/Xbox2Windows#254 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kludex/python-multipart#375 ·
Maintainers usually reply within 1 day