1POSIX_TRACE_GET_ATTR(3P)   POSIX Programmer's Manual  POSIX_TRACE_GET_ATTR(3P)
2
3
4

PROLOG

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

NAME

12       posix_trace_get_attr,  posix_trace_get_status  —  retrieve  the   trace
13       attributes or trace status (TRACING)
14

SYNOPSIS

16       #include <trace.h>
17
18       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

DESCRIPTION

23       The  posix_trace_get_attr()  function  shall copy the attributes of the
24       active trace stream identified by trid into the object  pointed  to  by
25       the attr argument.  If the Trace Log option is supported, trid may rep‐
26       resent a pre-recorded trace log.
27
28       The posix_trace_get_status() function shall return,  in  the  structure
29       pointed to by the statusinfo argument, the current trace status for the
30       trace stream identified by  the  trid  argument.  These  status  values
31       returned  in  the  structure  pointed  to by statusinfo shall have been
32       appropriately read to ensure that the returned values  are  consistent.
33       If  the Trace Log option is supported and the trid argument refers to a
34       pre-recorded trace stream, the status shall be the status of  the  com‐
35       pleted trace stream.
36
37       Each  time  the  posix_trace_get_status() function is used, the overrun
38       status of the trace stream shall  be  reset  to  POSIX_TRACE_NO_OVERRUN
39       immediately  after the call completes.  If the Trace Log option is sup‐
40       ported, the posix_trace_get_status() function shall behave the same  as
41       when the option is not supported except for the following differences:
42
43        *  If  the  trid argument refers to a trace stream with log, each time
44           the posix_trace_get_status() function is used, the log overrun sta‐
45           tus  of  the  trace stream shall be reset to POSIX_TRACE_NO_OVERRUN
46           and the flush_error status shall be reset to zero immediately after
47           the call completes.
48
49        *  If  the  trid  argument  refers to a pre-recorded trace stream, the
50           status returned shall be the status of the completed  trace  stream
51           and the status values of the trace stream shall not be reset.
52

RETURN VALUE

54       Upon  successful  completion,  these  functions shall return a value of
55       zero. Otherwise, they shall return the corresponding error number.
56
57       The posix_trace_get_attr() function stores the trace attributes in  the
58       object pointed to by attr, if successful.
59
60       The  posix_trace_get_status()  function  stores the trace status in the
61       object pointed to by statusinfo, if successful.
62

ERRORS

64       These functions shall fail if:
65
66       EINVAL The trace stream argument trid does not correspond  to  a  valid
67              active trace stream or a valid trace log.
68
69       The following sections are informative.
70

EXAMPLES

72       None.
73

APPLICATION USAGE

75       None.
76

RATIONALE

78       None.
79

FUTURE DIRECTIONS

81       The  posix_trace_get_attr()  and posix_trace_get_status() functions may
82       be removed in a future version.
83

SEE ALSO

85       posix_trace_attr_destroy(), posix_trace_close(), posix_trace_create()
86
87       The Base Definitions volume of POSIX.1‐2017, <trace.h>
88

90       Portions of this text are reprinted and reproduced in  electronic  form
91       from  IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
92       table Operating System Interface (POSIX), The Open Group Base  Specifi‐
93       cations  Issue  7, 2018 Edition, Copyright (C) 2018 by the Institute of
94       Electrical and Electronics Engineers, Inc and The Open Group.   In  the
95       event of any discrepancy between this version and the original IEEE and
96       The Open Group Standard, the original IEEE and The Open Group  Standard
97       is  the  referee document. The original Standard can be obtained online
98       at http://www.opengroup.org/unix/online.html .
99
100       Any typographical or formatting errors that appear  in  this  page  are
101       most likely to have been introduced during the conversion of the source
102       files to man page format. To report such errors,  see  https://www.ker‐
103       nel.org/doc/man-pages/reporting_bugs.html .
104
105
106
107IEEE/The Open Group                  2017             POSIX_TRACE_GET_ATTR(3P)
Impressum