PTHREAD...TPSHARED(3POSIX)

✨ PROLOG ✨

ok so bestie, quick heads up before we dive in πŸ’– this manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (so pls go check the corresponding Linux manual page for the deets on Linux behavior), or honestly the interface might not even be implemented on Linux at all. πŸ™ˆ


πŸŽ€ NAME πŸŽ€

pthread_condattr_getpshared, pthread_condattr_setpshared β€” get and set the process-shared condition variable attributes πŸ’…


🌸 SYNOPSIS 🌸

#include <pthread.h>

int pthread_condattr_getpshared(const pthread_condattr_t *restrict attr,
    int *restrict pshared);
int pthread_condattr_setpshared(pthread_condattr_t *attr,
    int pshared);

πŸ¦‹ DESCRIPTION πŸ¦‹

ok so here's the tea β˜•

pthread_condattr_getpshared() shall obtain the value of the process-shared attribute from the attributes object referenced by attr. It's giving "read the vibe, report back". πŸ‘‘

pthread_condattr_setpshared() shall set the process-shared attribute in an initialized attributes object referenced by attr. It's giving "change the vibe, respectfully". ✨

So what even is the process-shared attribute?? Bestie. Set it to PTHREAD_PROCESS_SHARED and you're basically saying: this condition variable can be operated upon by any thread that has access to the memory where the condition variable is allocated β€” even if that memory is shared by multiple processes. iconic behavior fr fr. See Section 2.9.9, Synchronization Object Copies and Alternative Mappings for further requirements (iykyk).

The default value of the attribute is PTHREAD_PROCESS_PRIVATE. 🏠

⚠️ lowkey important: the behavior is undefined if the value specified by the attr argument to pthread_condattr_getpshared() or pthread_condattr_setpshared() does not refer to an initialized condition variable attributes object. not me being dramatic, that's literally what it says. πŸ’€

⭐ RETURN VALUE ⭐

If successful, the pthread_condattr_setpshared() function shall return zero 🫢 β€” otherwise, an error number shall be returned to indicate the error.

If successful, the pthread_condattr_getpshared() function shall return zero and store the value of the process-shared attribute of attr into the object referenced by the pshared parameter. Otherwise, an error number shall be returned to indicate the error. πŸ’–


πŸ’œ ERRORS πŸ’œ

The pthread_condattr_setpshared() function may fail if:

  • EINVAL β€” the new value specified for the attribute is outside the range of legal values for that attribute. bestie that value is Not Invited. 🚫

These functions shall not return an error code of [EINTR]. periodt. βœ‹

The following sections are informative. (translation: the juicy lore, not the actual spec, but still slay) πŸ“


🌈 EXAMPLES 🌈

None. β€” yeah. nothing here. not a single one. moving on. 🧚


πŸŽ€ APPLICATION USAGE πŸŽ€

None. β€” again, nothing. the void. πŸ’€


πŸ”₯ RATIONALE πŸ”₯

If an implementation detects that the value specified by the attr argument to pthread_condattr_getpshared() or pthread_condattr_setpshared() does not refer to an initialized condition variable attributes object, it is recommended that the function should fail and report an [EINVAL] error. like, that's the polite thing to do honestly. πŸ™ˆ


πŸ‘‘ FUTURE DIRECTIONS πŸ‘‘

None. β€” she's stable, she's not going anywhere, main character energy forever. ✨


πŸ’– SEE ALSO πŸ’–

  • pthread_create()
  • pthread_cond_destroy()
  • pthread_condattr_destroy()
  • pthread_mutex_destroy()

The Base Definitions volume of POSIX.1‐2017, <pthread.h> πŸ“š


Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


ok bye bestie, that's the whole page!! πŸ’… this one came from IEEE/The Open Group, 2017 β€” the PTHREAD...TPSHARED(3POSIX) of it all. go forth and share your process-shared condition variables responsibly. πŸ¦‹βœ¨πŸ’–