1POSIX_TRACE_GET_ATTR(3P) POSIX Programmer's Manual POSIX_TRACE_GET_ATTR(3P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
12 posix_trace_get_attr, posix_trace_get_status - retrieve the trace
13 attributes or trace status (TRACING)
14
16 #include <trace.h>
17 int posix_trace_get_attr(trace_id_t trid, trace_attr_t *attr);
19 int posix_trace_get_status(trace_id_t trid,
20 struct posix_trace_status_info *statusinfo);
21
24 The posix_trace_get_attr() function shall copy the attributes of the
25 active trace stream identified by trid into the object pointed to by
26 the attr argument. If the Trace Log option is supported, trid may
27 represent a pre-recorded trace log.
28 The posix_trace_get_status() function shall return, in the structure
30 pointed to by the statusinfo argument, the current trace status for the
31 trace stream identified by the trid argument. These status values
32 returned in the structure pointed to by statusinfo shall have been
33 appropriately read to ensure that the returned values are consistent.
34 If the Trace Log option is supported and the trid argument refers to a
35 pre-recorded trace stream, the status shall be the status of the com‐
36 pleted trace stream.
37 Each time the posix_trace_get_status() function is used, the overrun
39 status of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN
40 immediately after the call completes. If the Trace Log option is sup‐
41 ported, the posix_trace_get_status() function shall behave the same as
42 when the option is not supported except for the following differences:
43 * If the trid argument refers to a trace stream with log, each time
45 the posix_trace_get_status() function is used, the log overrun sta‐
46 tus of the trace stream shall be reset to POSIX_TRACE_NO_OVERRUN and
47 the flush_error status shall be reset to zero immediately after the
48 call completes.
49 * If the trid argument refers to a pre-recorded trace stream, the sta‐
51 tus returned shall be the status of the completed trace stream and
52 the status values of the trace stream shall not be reset.
53
55 Upon successful completion, these functions shall return a value of
56 zero. Otherwise, they shall return the corresponding error number.
57 The posix_trace_get_attr() function stores the trace attributes in the
59 object pointed to by attr, if successful.
60 The posix_trace_get_status() function stores the trace status in the
62 object pointed to by statusinfo, if successful.
63
65 These functions shall fail if:
66 EINVAL The trace stream argument trid does not correspond to a valid
68 active trace stream or a valid trace log.
69 The following sections are informative.
72
74 None.
75
77 None.
78
80 None.
81
83 None.
84
86 posix_trace_attr_destroy(), posix_trace_attr_init(), posix_trace_cre‐
87 ate(), posix_trace_open(), the Base Definitions volume of
88 IEEE Std 1003.1-2001, <trace.h>
89
91 Portions of this text are reprinted and reproduced in electronic form
92 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
93 -- Portable Operating System Interface (POSIX), The Open Group Base
94 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
95 Electrical and Electronics Engineers, Inc and The Open Group. In the
96 event of any discrepancy between this version and the original IEEE and
97 The Open Group Standard, the original IEEE and The Open Group Standard
98 is the referee document. The original Standard can be obtained online
99 at http://www.opengroup.org/unix/online.html .
100IEEE/The Open Group 2003 POSIX_TRACE_GET_ATTR(3P)