diff options
author | Andreas Kling <kling@serenityos.org> | 2020-02-28 11:45:19 +0100 |
---|---|---|
committer | Andreas Kling <kling@serenityos.org> | 2020-02-28 12:55:58 +0100 |
commit | f72e5bbb17cd54aa0e75e4436ddcd7ca0fda4648 (patch) | |
tree | 4f66b2ea3a3ebfbde38c95832a2b21de373af291 /Base/usr/share/man/man2/shbuf_create.md | |
parent | 8460d02651a1669ba3cdcc7cf277ceda1c0447de (diff) | |
download | serenity-f72e5bbb17cd54aa0e75e4436ddcd7ca0fda4648.zip |
Kernel+LibC: Rename shared buffer syscalls to use a prefix
This feels a lot more consistent and Unixy:
create_shared_buffer() => shbuf_create()
share_buffer_with() => shbuf_allow_pid()
share_buffer_globally() => shbuf_allow_all()
get_shared_buffer() => shbuf_get()
release_shared_buffer() => shbuf_release()
seal_shared_buffer() => shbuf_seal()
get_shared_buffer_size() => shbuf_get_size()
Also, "shared_buffer_id" is shortened to "shbuf_id" all around.
Diffstat (limited to 'Base/usr/share/man/man2/shbuf_create.md')
-rw-r--r-- | Base/usr/share/man/man2/shbuf_create.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/Base/usr/share/man/man2/shbuf_create.md b/Base/usr/share/man/man2/shbuf_create.md new file mode 100644 index 0000000000..1a05a4efe3 --- /dev/null +++ b/Base/usr/share/man/man2/shbuf_create.md @@ -0,0 +1,27 @@ +## Name + +shbuf\_create - create a shareable memory buffer + +## Synopsis +```**c++ +#include <SharedBuffer.h> + +int shbuf_create(int size, void** buffer); +``` + +## Description + +Creates a new memory region that can be shared with other processes. The region is only accessible to the calling process by default. + +## Return value + +If a region is successfully created, `shbuf_create()` stores a pointer to the memory in `buffer` and returns a buffer ID. Otherwise, it returns -1 and sets `errno` to describe the error. + +## Errors + +* `EINVAL`: `size` is zero or negative. +* `EFAULT`: `buffer` is not a valid address. + +## See also + +* [`shbuf_allow_pid`(2)](shbuf_allow_pid.md) |