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

Clarify memory managment routines are world-collective #517

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/backmatter.tex
Original file line number Diff line number Diff line change
Expand Up @@ -697,6 +697,12 @@ \section{Version 1.6}
functions from a single entry in \openshmem[1.5] into separate entries.
\ChangelogRef{subsec:shmem_malloc, subsec:shmem_free, subsec:shmem_realloc,
subsec:shmem_align}%
%
\item Clarified that the \FUNC{shmem\_\{malloc, free, realloc, align,
malloc\_with\_hints, calloc\}} functions are collective operations on
the world team.
\ChangelogRef{subsec:shmem_malloc, subsec:shmem_free, subsec:shmem_realloc,
subsec:shmem_align, subsec:shmmallochint, subsec:shmem_calloc}%
\item Corrected the level argument's recommended value in API notes for
\FUNC{shmem\_pcontrol} to indicate that the value should be greater than
2 to enable profiling with profile library defined effects and
Expand Down
3 changes: 2 additions & 1 deletion content/shmem_align.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@


\apidescription{
The \FUNC{shmem\_align} routine allocates a block in the symmetric
The \FUNC{shmem\_align} routine is a collective operation on the
world team that allocates a block in the symmetric
heap that has a byte alignment specified by the \VAR{alignment}
argument. The value of \VAR{alignment} shall be a multiple of
\CONST{sizeof(void *)} that is also a power of two; otherwise, the
Expand Down
3 changes: 2 additions & 1 deletion content/shmem_free.tex
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
\end{apiarguments}

\apidescription{
The \FUNC{shmem\_free} routine causes the block to which \VAR{ptr}
The \FUNC{shmem\_free} routine is a collective operation on the
world team that causes the block to which \VAR{ptr}
points to be deallocated, that is, made available for further
allocation. If \VAR{ptr} is a null pointer, no action is performed;
otherwise, \FUNC{shmem\_free} calls a barrier on entry.
Expand Down
3 changes: 2 additions & 1 deletion content/shmem_malloc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@


\apidescription{
The \FUNC{shmem\_malloc} routine returns the symmetric address of a
The \FUNC{shmem\_malloc} routine is a collective operation on the
world team and returns the symmetric address of a
block of at least \VAR{size} bytes, which shall be suitably aligned
so that it may be assigned to a pointer to any type of object.
This space is allocated from the symmetric heap (in contrast to
Expand Down
3 changes: 2 additions & 1 deletion content/shmem_malloc_hints.tex
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@

\apidescription{

The \FUNC{shmem\_malloc\_with\_hints} routine, like \FUNC{shmem\_malloc}, returns a pointer to a block of at least
The \FUNC{shmem\_malloc\_with\_hints} routine, like \FUNC{shmem\_malloc},
is a collective operation on the world team that returns a pointer to a block of at least
\VAR{size} bytes, which shall be suitably aligned so that it may be
assigned to a pointer to any type of object. This space is allocated from
the symmetric heap (similar to \FUNC{shmem\_malloc}). When the \VAR{size} is zero,
Expand Down
3 changes: 2 additions & 1 deletion content/shmem_realloc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@


\apidescription{
The \FUNC{shmem\_realloc} routine changes the size of the block to
The \FUNC{shmem\_realloc} routine is a collective operation on
the world team that changes the size of the block to
which \VAR{ptr} points to the size (in bytes) specified by
\VAR{size}. The contents of the block are unchanged up to the
lesser of the new and old sizes.
Expand Down