POSIX_T...DESTROY(3POSIX)

🌸 PROLOG 🌸

okay bestie, real talk before anything else: this page is part of the POSIX Programmer's Manual, and that's the whole vibe. The Linux implementation of this interface may differ (so if you're on Linux, go consult the corresponding Linux manual page for details of Linux behavior), or β€” and I cannot stress this enough β€” the interface may not be implemented on Linux at all. πŸ’€


✨ NAME ✨

posix_trace_attr_destroy, posix_trace_attr_init β€” destroy and initialize the trace stream attributes object (TRACING)

This is the manual page for POSIX_T...DESTROY(3POSIX), and yes she's serving two functions in one page because they're literally each other's other half. 🫢


πŸŽ€ SYNOPSIS πŸŽ€

#include <trace.h>

int posix_trace_attr_destroy(trace_attr_t *attr);
int posix_trace_attr_init(trace_attr_t *attr);

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so. Two functions, one attributes object, let's go. πŸ’…

posix_trace_attr_destroy() shall destroy an initialized trace attributes object. And here's the cute part β€” a destroyed attr attributes object can be reinitialized using posix_trace_attr_init(). It's giving recycle, it's giving second chance era. ✨

But listen: the results of otherwise referencing the object after it has been destroyed are undefined. Not "probably fine", not "lowkey fine" β€” undefined. Do not be out here poking a destroyed object, bestie, that's not the move. πŸ’€

posix_trace_attr_init() shall initialize a trace attributes object attr with the default value for all of the individual attributes used by a given implementation. The read-only generation-version and clock-resolution attributes of the newly initialized trace attributes object shall be set to their appropriate values (see Section 2.11.1.2, posix_trace_status_info Structure). Slay.

⚠️ Results are undefined if posix_trace_attr_init() is called specifying an already initialized attr attributes object. Like, no. Don't double-init. That's the rule. Periodt.

Implementations may add extensions to the trace attributes object structure as permitted in the Base Definitions volume of POSIX.1‐2017, Chapter 2, Conformance. (Extensions = they can decorate, and honestly, respect. πŸŽ€)

The resulting attributes object (possibly modified by setting individual attributes values), when used by posix_trace_create(), defines the attributes of the trace stream created. A single attributes object can be used in multiple calls to posix_trace_create() β€” one object, many streams, main character energy fr fr. πŸ”₯

After one or more trace streams have been created using an attributes object, any function affecting that attributes object, including destruction, shall not affect any trace stream previously created. The streams are independent, they said what they said, they're not taking it back. πŸ‘‘

An initialized attributes object also serves to receive the attributes of an existing trace stream or trace log when calling the posix_trace_get_attr() function. So it's both a giver and a receiver. Versatile icon. 🌈


πŸ’– RETURN VALUE πŸ’–

Upon successful completion, these functions shall return a value of zero. Otherwise, they shall return the corresponding error number. That's it, that's the contract. 🫢


πŸ”₯ ERRORS πŸ”₯

The posix_trace_attr_destroy() function may fail if:

  • EINVAL β€” the value of attr is invalid. ma'am, that's not a valid object. πŸ™ˆ

The posix_trace_attr_init() function shall fail if:

  • ENOMEM β€” insufficient memory exists to initialize the trace attributes object. she's out of storage, she cannot come to the phone right now. 😭

The following sections are informative. (iykyk πŸ’…)


🌟 EXAMPLES 🌟

None.

(Yeah. None. Nothing to demo here, it's just init and destroy, the functions are doing their little job and going home. 😌)


πŸ’œ APPLICATION USAGE πŸ’œ

None.


🌺 RATIONALE 🌺

None.


🧚 FUTURE DIRECTIONS 🧚

The posix_trace_attr_destroy() and posix_trace_attr_init() functions may be removed in a future version.

not me getting emotional over deprecation... the possibility is real though, so plan accordingly. πŸ’€

⭐ SEE ALSO ⭐

  • posix_trace_create()
  • posix_trace_get_attr()
  • uname()

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 πŸ’– this was IEEE/The Open Group, 2017, closing out POSIX_T...DESTROY(3POSIX) β€” init her, destroy her, reinit her again, we love a reversible icon. πŸŽ€βœ¨πŸ¦‹