POSIX_TRACE_GET_ATTR(3P)

πŸ’– POSIX_TRACE_GET_ATTR(3P) β€” POSIX Programmer's Manual πŸ’–

okay bestie, so this one lives in the POSIX Programmer's Manual, and the whole manual name is literally POSIX_TRACE_GET_ATTR(3P). Cute. Now the tea:

🌈 PROLOG 🌈

So this manual page is part of the POSIX Programmer's Manual, right? But heads up, girlie β€” the Linux implementation of this interface may differ (so go check the corresponding Linux manual page for the actual Linux behavior), or the interface might not even be implemented on Linux at all. πŸ’€ No cap, that's just how it is.


✨ NAME ✨

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

πŸŽ€ 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 πŸ¦‹

So posix_trace_get_attr() shall copy the attributes of the active trace stream identified by trid into the object pointed to by the attr argument. Slay. And if the Trace Log option is supported, trid may represent a pre-recorded trace log. πŸ‘‘

Then posix_trace_get_status() shall return, in the structure pointed to by the statusinfo argument, the current trace status for the trace stream identified by the trid argument. These status values returned in the structure pointed to by statusinfo shall have been appropriately read to ensure that the returned values are consistent. 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. Periodt.

Every single time posix_trace_get_status() is used, the overrun status of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN immediately after the call completes. Note that. 🫢

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 little plot twists:

  • 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. Leave them alone, she's fine. πŸ’…

πŸ’« RETURN VALUE πŸ’«

Upon successful completion, these functions shall return a value of zero. Otherwise, they shall return the corresponding error number. That's the whole vibe check.

  • The posix_trace_get_attr() function stores the trace attributes in the object pointed to by attr, if successful.
  • The posix_trace_get_status() function stores the trace status in the object pointed to by statusinfo, if successful.

πŸ™ˆ 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.
and yes, the following sections are informative, so they're basically the bonus content πŸ’œ

🌸 EXAMPLES 🌸

None. She said nothing. Not a single example. πŸ“

🧚 APPLICATION USAGE 🧚

None. Also nothing. Icons of minimalism, honestly.

⭐ RATIONALE ⭐

None. The mystery continues, bestie. πŸ”₯

πŸ’œ FUTURE DIRECTIONS πŸ’œ

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, iykyk. 😭

πŸ‘‘ SEE ALSO πŸ‘‘

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

And from the Base Definitions volume of POSIX.1‐2017: <trace.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!! brought to you by IEEE/The Open Group, 2017 β€” mwah, love that for us πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from