1POSIX_TRACE_ATTR_GETCLOCKRESP(O3SPI)X Programmer's MPaOnSuIaXl_TRACE_ATTR_GETCLOCKRES(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_attr_getclockres,           posix_trace_attr_getcreatetime,
13       posix_trace_attr_getgenversion,               posix_trace_attr_getname,
14       posix_trace_attr_setname — retrieve and set information about  a  trace
15       stream (TRACING)
16

SYNOPSIS

18       #include <time.h>
19       #include <trace.h>
20
21       int posix_trace_attr_getclockres(const trace_attr_t *attr,
22           struct timespec *resolution);
23       int posix_trace_attr_getcreatetime(const trace_attr_t *attr,
24           struct timespec *createtime);
25
26       #include <trace.h>
27
28       int posix_trace_attr_getgenversion(const trace_attr_t *attr,
29           char *genversion);
30       int posix_trace_attr_getname(const trace_attr_t *attr,
31           char *tracename);
32       int posix_trace_attr_setname(trace_attr_t *attr,
33           const char *tracename);
34

DESCRIPTION

36       The  posix_trace_attr_getclockres() function shall copy the clock reso‐
37       lution of the clock used to generate timestamps from the  clock-resolu‐
38       tion attribute of the attributes object pointed to by the attr argument
39       into the structure pointed to by the resolution argument.
40
41       The posix_trace_attr_getcreatetime()  function  shall  copy  the  trace
42       stream creation time from the creation-time attribute of the attributes
43       object pointed to by the attr argument into the structure pointed to by
44       the  createtime  argument.  The creation-time attribute shall represent
45       the time of creation of the trace stream.
46
47       The posix_trace_attr_getgenversion() function  shall  copy  the  string
48       containing version information from the generation-version attribute of
49       the attributes object pointed to by the attr argument into  the  string
50       pointed to by the genversion argument. The genversion argument shall be
51       the  address  of  a  character  array  which   can   store   at   least
52       {TRACE_NAME_MAX} characters.
53
54       The  posix_trace_attr_getname() function shall copy the string contain‐
55       ing the trace name from the  trace-name  attribute  of  the  attributes
56       object  pointed  to  by the attr argument into the string pointed to by
57       the tracename argument. The tracename argument shall be the address  of
58       a character array which can store at least {TRACE_NAME_MAX} characters.
59
60       The  posix_trace_attr_setname()  function  shall  set  the  name in the
61       trace-name attribute of the attributes object pointed to  by  the  attr
62       argument,  using  the trace name string supplied by the tracename argu‐
63       ment. If the supplied string contains more than {TRACE_NAME_MAX}  char‐
64       acters,  the name copied into the trace-name attribute may be truncated
65       to one less than the length of {TRACE_NAME_MAX} characters. The default
66       value is a null string.
67

RETURN VALUE

69       Upon  successful  completion,  these  functions shall return a value of
70       zero. Otherwise, they shall return the corresponding error number.
71
72       If successful, the posix_trace_attr_getclockres() function  stores  the
73       clock-resolution  attribute  value  in the object pointed to by resolu‐
74       tion.  Otherwise, the content of this object is unspecified.
75
76       If successful, the posix_trace_attr_getcreatetime() function stores the
77       trace  stream  creation  time  in  the object pointed to by createtime.
78       Otherwise, the content of this object is unspecified.
79
80       If successful, the posix_trace_attr_getgenversion() function stores the
81       trace version information in the string pointed to by genversion.  Oth‐
82       erwise, the content of this string is unspecified.
83
84       If successful, the posix_trace_attr_getname() function stores the trace
85       name  in the string pointed to by tracename.  Otherwise, the content of
86       this string is unspecified.
87

ERRORS

89       The  posix_trace_attr_getclockres(),  posix_trace_attr_getcreatetime(),
90       posix_trace_attr_getgenversion(),  and posix_trace_attr_getname() func‐
91       tions may fail if:
92
93       EINVAL The value specified by one of the arguments is invalid.
94
95       The following sections are informative.
96

EXAMPLES

98       None.
99

APPLICATION USAGE

101       None.
102

RATIONALE

104       None.
105

FUTURE DIRECTIONS

107       The  posix_trace_attr_getclockres(),  posix_trace_attr_getcreatetime(),
108       posix_trace_attr_getgenversion(),    posix_trace_attr_getname(),    and
109       posix_trace_attr_setname() functions may be removed in  a  future  ver‐
110       sion.
111

SEE ALSO

113       posix_trace_attr_destroy(),                       posix_trace_create(),
114       posix_trace_get_attr(), uname()
115
116       The Base Definitions volume of POSIX.1‐2017, <time.h>, <trace.h>
117
119       Portions of this text are reprinted and reproduced in  electronic  form
120       from  IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
121       table Operating System Interface (POSIX), The Open Group Base  Specifi‐
122       cations  Issue  7, 2018 Edition, Copyright (C) 2018 by the Institute of
123       Electrical and Electronics Engineers, Inc and The Open Group.   In  the
124       event of any discrepancy between this version and the original IEEE and
125       The Open Group Standard, the original IEEE and The Open Group  Standard
126       is  the  referee document. The original Standard can be obtained online
127       at http://www.opengroup.org/unix/online.html .
128
129       Any typographical or formatting errors that appear  in  this  page  are
130       most likely to have been introduced during the conversion of the source
131       files to man page format. To report such errors,  see  https://www.ker
132       nel.org/doc/man-pages/reporting_bugs.html .
133
134
135
136IEEE/The Open Group                  2017     POSIX_TRACE_ATTR_GETCLOCKRES(3P)
Impressum