logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

posix_trace_get_attr.3p (4314B)

    

  1. '\" et
  2. .TH POSIX_TRACE_GET_ATTR "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. posix_trace_get_attr,
  12. posix_trace_get_status
  13. \(em retrieve the trace attributes or trace status
  14. (\fBTRACING\fP)
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <trace.h>
  19. .P
  20. int posix_trace_get_attr(trace_id_t \fItrid\fP, trace_attr_t *\fIattr\fP);
  21. int posix_trace_get_status(trace_id_t \fItrid\fP,
  22.     struct posix_trace_status_info *\fIstatusinfo\fP);
  23. .fi
  24. .SH DESCRIPTION
  25. The
  26. \fIposix_trace_get_attr\fR()
  27. function shall copy the attributes of the active trace stream
  28. identified by
  29. .IR trid
  30. into the object pointed to by the
  31. .IR attr
  32. argument.
  33. If the Trace Log option is supported,
  34. .IR trid
  35. may represent a pre-recorded trace log.
  36. .P
  37. The
  38. \fIposix_trace_get_status\fR()
  39. function shall return, in the structure pointed to by the
  40. .IR statusinfo
  41. argument, the current trace status for the trace stream identified by
  42. the
  43. .IR trid
  44. argument. These status values returned in the structure pointed to by
  45. .IR statusinfo
  46. shall have been appropriately read to ensure that the returned values
  47. are consistent.
  48. If the Trace Log option is supported and the
  49. .IR trid
  50. argument refers to a pre-recorded trace stream, the status shall be the
  51. status of the completed trace stream.
  52. .P
  53. Each time the
  54. \fIposix_trace_get_status\fR()
  55. function is used, the overrun status of the trace stream shall be reset
  56. to POSIX_TRACE_NO_OVERRUN
  57. immediately after the call completes.
  58. If the Trace Log option is supported, the
  59. \fIposix_trace_get_status\fR()
  60. function shall behave the same as when the option is not supported
  61. except for the following differences:
  62. .IP " *" 4
  63. If the
  64. .IR trid
  65. argument refers to a trace stream with log, each time the
  66. \fIposix_trace_get_status\fR()
  67. function is used, the log overrun status of the trace stream shall be
  68. reset to POSIX_TRACE_NO_OVERRUN and the
  69. .IR flush_error
  70. status shall be reset to zero immediately after the call completes.
  71. .IP " *" 4
  72. If the
  73. .IR trid
  74. argument refers to a pre-recorded trace stream, the status returned
  75. shall be the status of the completed trace stream and the status values
  76. of the trace stream shall not be reset.
  77. .SH "RETURN VALUE"
  78. Upon successful completion, these functions shall return a value of
  79. zero. Otherwise, they shall return the corresponding error number.
  80. .P
  81. The
  82. \fIposix_trace_get_attr\fR()
  83. function stores the trace attributes in the object pointed to by
  84. .IR attr ,
  85. if successful.
  86. .P
  87. The
  88. \fIposix_trace_get_status\fR()
  89. function stores the trace status in the object pointed to by
  90. .IR statusinfo ,
  91. if successful.
  92. .SH ERRORS
  93. These functions shall fail if:
  94. .TP
  95. .BR EINVAL
  96. The trace stream argument
  97. .IR trid
  98. does not correspond to a valid active trace stream or a valid trace
  99. log.
  100. .LP
  101. .IR "The following sections are informative."
  102. .SH EXAMPLES
  103. None.
  104. .SH "APPLICATION USAGE"
  105. None.
  106. .SH RATIONALE
  107. None.
  108. .SH "FUTURE DIRECTIONS"
  109. The
  110. \fIposix_trace_get_attr\fR()
  111. and
  112. \fIposix_trace_get_status\fR()
  113. functions may be removed in a future version.
  114. .SH "SEE ALSO"
  115. .ad l
  116. .IR "\fIposix_trace_attr_destroy\fR\^(\|)",
  117. .IR "\fIposix_trace_close\fR\^(\|)",
  118. .IR "\fIposix_trace_create\fR\^(\|)"
  119. .ad b
  120. .P
  121. The Base Definitions volume of POSIX.1\(hy2017,
  122. .IR "\fB<trace.h>\fP"
  123. .\"
  124. .SH COPYRIGHT
  125. Portions of this text are reprinted and reproduced in electronic form
  126. from IEEE Std 1003.1-2017, Standard for Information Technology
  127. -- Portable Operating System Interface (POSIX), The Open Group Base
  128. Specifications Issue 7, 2018 Edition,
  129. Copyright (C) 2018 by the Institute of
  130. Electrical and Electronics Engineers, Inc and The Open Group.
  131. In the event of any discrepancy between this version and the original IEEE and
  132. The Open Group Standard, the original IEEE and The Open Group Standard
  133. is the referee document. The original Standard can be obtained online at
  134. http://www.opengroup.org/unix/online.html .
  135. .PP
  136. Any typographical or formatting errors that appear
  137. in this page are most likely
  138. to have been introduced during the conversion of the source files to
  139. man page format. To report such errors, see
  140. https://www.kernel.org/doc/man-pages/reporting_bugs.html .