Skip to content

docs: design#216

Merged
casaroli merged 2 commits into
mainfrom
design-docs
May 25, 2026
Merged

docs: design#216
casaroli merged 2 commits into
mainfrom
design-docs

Conversation

@casaroli
Copy link
Copy Markdown
Collaborator

@casaroli casaroli commented May 25, 2026

Add the initial docs about design and code structure.

@casaroli casaroli requested review from kr-t and srberard as code owners May 25, 2026 08:42
@casaroli
Copy link
Copy Markdown
Collaborator Author

casaroli commented May 25, 2026 •
edited
Loading 

Filename                                                         Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
ocre/context.c                                                       375               155    58.67%          10                 0   100.00%         291                80    72.51%         190                95    50.00%
ocre/container.c                                                     709               381    46.26%          15                 0   100.00%         495               197    60.20%         360               223    38.06%
ocre/util/unique_random_id.c                                          21                 4    80.95%           3                 0   100.00%          29                 6    79.31%          12                 4    66.67%
ocre/util/string_array.c                                              39                18    53.85%           4                 0   100.00%          53                27    49.06%          24                14    41.67%
ocre/util/rm_rf.c                                                     66                15    77.27%           4                 0   100.00%         114                42    63.16%          44                16    63.64%
ocre/ocre.c                                                          451               191    57.65%           9                 0   100.00%         291                91    68.73%         226               131    42.04%
runtime/wamr-wasip1/wamr.c                                           298               183    38.59%           7                 0   100.00%         282               135    52.13%         162               111    31.48%
runtime/wamr-wasip1/ocre_api/core/core_mutex.c                         7                 4    42.86%           4                 3    25.00%          14                10    28.57%           2                 1    50.00%
runtime/wamr-wasip1/ocre_api/core/core_memory.c                        2                 0   100.00%           2                 0   100.00%           6                 0   100.00%           0                 0         -
runtime/wamr-wasip1/ocre_api/core/core_timer.c                        24                24     0.00%           5                 5     0.00%          43                43     0.00%          14                14     0.00%
runtime/wamr-wasip1/ocre_api/core/core_eventq.c                       19                10    47.37%           5                 2    60.00%          57                30    47.37%          10                 6    40.00%
runtime/wamr-wasip1/ocre_api/core/core_misc.c                          3                 2    33.33%           3                 2    33.33%          13                 8    38.46%           0                 0         -
runtime/wamr-wasip1/ocre_api/ocre_api.c                               18                18     0.00%           2                 2     0.00%          25                25     0.00%           6                 6     0.00%
runtime/wamr-wasip1/ocre_api/ocre_common.c                           245               163    33.47%          13                 5    61.54%         220               147    33.18%         134               107    20.15%
runtime/wamr-wasip1/ocre_api/ocre_messaging/ocre_messaging.c         225               225     0.00%           5                 5     0.00%         182               182     0.00%         118               118     0.00%
runtime/wamr-wasip1/ocre_api/ocre_timers/ocre_timer.c                272               245     9.93%           8                 6    25.00%         170               154     9.41%         146               137     6.16%
runtime/wamr-wasip1/ocre_api/utils/strlcat.c                          12                12     0.00%           1                 1     0.00%          21                21     0.00%          10                10     0.00%
common/common.c                                                       23                 1    95.65%           1                 0   100.00%          16                 2    87.50%          14                 2    85.71%
platform/posix/lstat.c                                                 1                 0   100.00%           1                 0   100.00%           3                 0   100.00%           0                 0         -
platform/posix/file_mmap.c                                            78                53    32.05%           2                 0   100.00%          61                37    39.34%          38                27    28.95%
platform/posix/memory.c                                                3                 0   100.00%           3                 0   100.00%           9                 0   100.00%           0                 0         -

Files which contain no functions:
uthash/include/uthash/utlist.h                                         0                 0         -           0                 0         -           0                 0         -           0                 0         -
runtime/wamr-wasip1/ocre_api/core/core_internal.h                      0                 0         -           0                 0         -           0                 0         -           0                 0         -
runtime/wamr-wasip1/ocre_api/ocre_api.h                                0                 0         -           0                 0         -           0                 0         -           0                 0         -
platform/posix/include/ocre/platform/log.h                             0                 0         -           0                 0         -           0                 0         -           0                 0         -
platform/posix/include/ocre/platform/config.h                          0                 0         -           0                 0         -           0                 0         -           0                 0         -
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                               2891              1704    41.06%         107                31    71.03%        2395              1237    48.35%        1510              1022    32.32%

@casaroli
docs: design
1761d4c 
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
kr-t
kr-t reviewed May 25, 2026
View reviewed changes
Comment thread docs/Design.md Outdated

The built-in runtime is **WAMR/WASI-P1** (`wamr/wasip1`), which uses the WebAssembly Micro-Runtime to execute WASM modules compiled against the WASI Preview 1 ABI. Additional runtime engines can be registered at initialization time via `ocre_initialize()`.

Refer to the [Custom Runtime Engine](CustomRuntimeEngine.md) documentation for more details.
Copy link
Copy Markdown
Collaborator

@kr-t kr-t May 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

nit: not sure if we want to refer to a non existing doc

Copy link
Copy Markdown
Collaborator Author

@casaroli casaroli May 25, 2026

Choose a reason for hiding this comment

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

i commented it out

Copy link
Copy Markdown
Collaborator Author

@casaroli casaroli May 25, 2026

Choose a reason for hiding this comment

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

i removed

kr-t
kr-t previously approved these changes May 25, 2026
View reviewed changes
@casaroli
docs(Design): remove link to non existing doc
65de190 
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@casaroli casaroli merged commit c21cc29 into main May 25, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

@srberard srberard Awaiting requested review from srberard srberard is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@casaroli @kr-t