Skip to content
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.

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

To document SHM API use examples #43

Open
iartemov-ledger opened this issue Sep 18, 2024 · 0 comments
Open

To document SHM API use examples #43

iartemov-ledger opened this issue Sep 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@iartemov-ledger
Copy link
Contributor

The SHM API family is already quite well described (https://outpost-sentry.readthedocs.io/en/latest/uapi/syscalls/get_shm_handle.html etc.)
What is missed is:

  • some examples of sequencing of actions/calls for real SHM use cases, starting shared memory node(s) definition in corresponding .dts and finishing by its use in application
  • some clarifications including:
    • the necessity to set credentials for the owner task itself
    • when the permission transfer is employed
    • the fact that get_shm_handle() can fail on user side if the owner has not yet set corresponding permissions (and the ways to workaround this)

After, should we elaborate on this or sooner promote a higher-level Posix-like SHM API: https://man7.org/linux/man-pages/man7/shm_overview.7.html ?

@iartemov-ledger iartemov-ledger added the documentation Improvements or additions to documentation label Sep 18, 2024
@iartemov-ledger iartemov-ledger added this to the Sentry-v1.0.0 milestone Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant