POSIX_SPA...SCHEDPARAM(3P)

πŸ’– POSIX_SPA...SCHEDPARAM(3P) πŸ’–

okay bestie so this is a page from the POSIX Programmer's Manual (yes, that POSIX, the icon herself) and we're talking about posix_spawnattr_getschedparam and posix_spawnattr_setschedparam. scheduling vibes. spawn attributes. we love a niche API moment 🫢

🌸 PROLOG 🌸

bestie, real talk before we get into it: this manual page is part of the POSIX Programmer's Manual. the Linux implementation of this interface may differ (so go consult the corresponding Linux manual page for the deets on Linux behavior), or the interface may literally not be implemented on Linux at all. so like. check first. πŸ’€


✨ NAME ✨

posix_spawnattr_getschedparam, posix_spawnattr_setschedparam β€” get and set the spawn-schedparam attribute of a spawn attributes object (ADVANCED REALTIME)

πŸŽ€ SYNOPSIS πŸŽ€

#include <spawn.h>
#include <sched.h>

int posix_spawnattr_getschedparam(const posix_spawnattr_t
    *restrict attr, struct sched_param *restrict schedparam);
int posix_spawnattr_setschedparam(posix_spawnattr_t *restrict attr,
    const struct sched_param *restrict schedparam);

πŸ’… DESCRIPTION πŸ’…

so, posix_spawnattr_getschedparam() shall obtain the value of the spawn-schedparam attribute from the attributes object referenced by attr. that's the whole assignment. get the thing. πŸ’–

and posix_spawnattr_setschedparam() shall set the spawn-schedparam attribute in an initialized attributes object referenced by attr. set the thing. slay. ✨

the spawn-schedparam attribute represents the scheduling parameters to be assigned to the new process image in a spawn operation β€” but only if POSIX_SPAWN_SETSCHEDULER or POSIX_SPAWN_SETSCHEDPARAM is set in the spawn-flags attribute. iykyk. and the default value of this attribute is... unspecified. πŸ™ˆ yeah. unspecified. no cap.

the default is unspecified, so don't go assuming it's zero or anything cute like that. it's just vibes and mystery.

πŸ”₯ RETURN VALUE πŸ”₯

upon successful completion, posix_spawnattr_getschedparam() shall return zero and store the value of the spawn-schedparam attribute of attr into the object referenced by the schedparam parameter. otherwise, an error number shall be returned to indicate the error. 😭

upon successful completion, posix_spawnattr_setschedparam() shall return zero. otherwise, an error number shall be returned to indicate the error. periodt.

🌈 ERRORS 🌈

these functions may fail if:

  • EINVAL β€” the value specified by attr is invalid. not valid. invalid. πŸ’€

the posix_spawnattr_setschedparam() function may fail if:

  • EINVAL β€” the value of the attribute being set is not valid. (yes, again. different reason though. read it.)
heads up bestie: the following sections are informative.

πŸ¦‹ EXAMPLES πŸ¦‹

None.

(yeah. literally none. the page said None and i'm not about to invent examples for you, that's not the vibe. 🧚)

πŸ’œ APPLICATION USAGE πŸ’œ

these functions are part of the Spawn and Process Scheduling options and need not be provided on all implementations. so if you can't find them, it's not you, it's the implementation. πŸ‘‘

⭐ RATIONALE ⭐

None.

🌸 FUTURE DIRECTIONS 🌸

None.

πŸŽ€ SEE ALSO πŸŽ€

  • posix_spawn()
  • posix_spawnattr_destroy()
  • posix_spawnattr_getsigdefault()
  • posix_spawnattr_getflags()
  • posix_spawnattr_getpgroup()
  • posix_spawnattr_getschedpolicy()
  • posix_spawnattr_getsigmask()

the Base Definitions volume of POSIX.1‐2017, <sched.h>, <spawn.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 .


and that's the whole page bestie!! courtesy of IEEE/The Open Group, 2017 β€” mwah, tysm for reading, go schedule something responsibly πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from