POSIX_T...ET_ATTR(3POSIX)

✨ PROLOG ✨

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


πŸ’– NAME πŸ’–

posix_trace_get_attr, posix_trace_get_status β€” retrieve the trace attributes or trace status (TRACING)

like yes, we're getting the vibes of your trace. the attributes, the status, the whole picture. 🌸


πŸŽ€ SYNOPSIS πŸŽ€

#include <trace.h>

int posix_trace_get_attr(trace_id_t trid, trace_attr_t *attr);
int posix_trace_get_status(trace_id_t trid,
    struct posix_trace_status_info *statusinfo);

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so posix_trace_get_attr() is the one that shall copy the attributes of the active trace stream identified by trid into the object pointed to by the attr argument. and if the Trace Log option is supported? then trid may also represent a pre-recorded trace log. iconic behavior honestly. ✨

then we have posix_trace_get_status(), which shall return β€” in the structure pointed to by the statusinfo argument β€” the current trace status for the trace stream identified by the trid argument. and the way that these status values returned in the structure pointed to by statusinfo shall have been appropriately read to ensure that the returned values are consistent? yeah. that's the assignment. 🫢 and if the Trace Log option is supported and the trid argument refers to a pre-recorded trace stream, the status shall be the status of the completed trace stream.

heads up bestie, this next part matters πŸ‘‡

each time the posix_trace_get_status() function is used, the overrun status of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN immediately after the call completes. so it's like, one shot, then reset. no cap.

and if the Trace Log option is supported, posix_trace_get_status() shall behave the same as when the option is not supported β€” except for these two differences:

  • if the trid argument refers to a trace stream with log, each time the posix_trace_get_status() function is used, the log overrun status of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN and the flush_error status shall be reset to zero immediately after the call completes. 🧚
  • if the trid argument refers to a pre-recorded trace stream, the status returned shall be the status of the completed trace stream and the status values of the trace stream shall not be reset. lowkey the chill one. 😌

⭐ RETURN VALUE ⭐

upon successful completion, these functions shall return a value of zero. otherwise, they shall return the corresponding error number. (yes, error number, not -1. she's different like that πŸ’…)

posix_trace_get_attr() stores the trace attributes in the object pointed to by attr, if successful. and posix_trace_get_status() stores the trace status in the object pointed to by statusinfo, if successful. cute, right? πŸŽ€


🌈 ERRORS 🌈

these functions shall fail if:

  • EINVAL β€” the trace stream argument trid does not correspond to a valid active trace stream or a valid trace log. πŸ’€ like bestie that trace does NOT exist, vibe check failed.

the following sections are informative.


🌸 EXAMPLES 🌸

None.

(it's giving "no thoughts, head empty" but make it a spec 🫢)


πŸ’œ APPLICATION USAGE πŸ’œ

None.


🧚 RATIONALE 🧚

None.


πŸ‘‘ FUTURE DIRECTIONS πŸ‘‘

okay so not to be dramatic but… the posix_trace_get_attr() and posix_trace_get_status() functions may be removed in a future version. so like, enjoy them while they last bestie. 😭


πŸ”₯ SEE ALSO πŸ”₯

  • posix_trace_attr_destroy()
  • posix_trace_close()
  • posix_trace_create()

the Base Definitions volume of POSIX.1‐2017, <trace.h> β€” go read the header, it's the main character. πŸ“–


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 .


okay and for the lil sign-off moment: this whole thing is brought to you by IEEE/The Open Group, 2017, filed under POSIX_T...ET_ATTR(3POSIX) β€” mwah, slay, periodt. πŸ’–βœ¨πŸŽ€