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_start.3p (3536B)


  1. '\" et
  2. .TH POSIX_TRACE_START "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_start,
  12. posix_trace_stop
  13. \(em trace start and stop
  14. (\fBTRACING\fP)
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <trace.h>
  19. .P
  20. int posix_trace_start(trace_id_t \fItrid\fP);
  21. int posix_trace_stop (trace_id_t \fItrid\fP);
  22. .fi
  23. .SH DESCRIPTION
  24. The
  25. \fIposix_trace_start\fR()
  26. and
  27. \fIposix_trace_stop\fR()
  28. functions, respectively, shall start and stop the trace stream
  29. identified by the argument
  30. .IR trid .
  31. .P
  32. The effect of calling the
  33. \fIposix_trace_start\fR()
  34. function shall be recorded in the trace stream as the POSIX_TRACE_START
  35. system trace event and the status of the trace stream shall become
  36. POSIX_TRACE_RUNNING.
  37. If the trace stream is in progress when this function is called, the
  38. POSIX_TRACE_START
  39. system trace event shall not be recorded and the trace stream shall
  40. continue to run. If the trace stream is full, the POSIX_TRACE_START
  41. system trace event shall not be recorded and the status of the trace
  42. stream shall not be changed.
  43. .P
  44. The effect of calling the
  45. \fIposix_trace_stop\fR()
  46. function shall be recorded in the trace stream as the POSIX_TRACE_STOP
  47. system trace event and the status of the trace stream shall become
  48. POSIX_TRACE_SUSPENDED.
  49. If the trace stream is suspended when this function is called, the
  50. POSIX_TRACE_STOP system trace event shall not be recorded and the trace
  51. stream shall remain suspended. If the trace stream is full, the
  52. POSIX_TRACE_STOP system trace event shall not be recorded and the
  53. status of the trace stream shall not be changed.
  54. .SH "RETURN VALUE"
  55. Upon successful completion, these functions shall return a value of
  56. zero. Otherwise, they shall return the corresponding error number.
  57. .SH ERRORS
  58. These functions shall fail if:
  59. .TP
  60. .BR EINVAL
  61. The value of the argument
  62. .IR trid
  63. does not correspond to an active trace stream and thus no trace stream
  64. was started or stopped.
  65. .TP
  66. .BR EINTR
  67. The operation was interrupted by a signal and thus the trace stream was
  68. not necessarily started or stopped.
  69. .LP
  70. .IR "The following sections are informative."
  71. .SH EXAMPLES
  72. None.
  73. .SH "APPLICATION USAGE"
  74. None.
  75. .SH RATIONALE
  76. None.
  77. .SH "FUTURE DIRECTIONS"
  78. The
  79. \fIposix_trace_start\fR()
  80. and
  81. \fIposix_trace_stop\fR()
  82. functions may be removed in a future version.
  83. .SH "SEE ALSO"
  84. .IR "\fIposix_trace_create\fR\^(\|)"
  85. .P
  86. The Base Definitions volume of POSIX.1\(hy2017,
  87. .IR "\fB<trace.h>\fP"
  88. .\"
  89. .SH COPYRIGHT
  90. Portions of this text are reprinted and reproduced in electronic form
  91. from IEEE Std 1003.1-2017, Standard for Information Technology
  92. -- Portable Operating System Interface (POSIX), The Open Group Base
  93. Specifications Issue 7, 2018 Edition,
  94. Copyright (C) 2018 by the Institute of
  95. Electrical and Electronics Engineers, Inc and The Open Group.
  96. In the 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 at
  99. http://www.opengroup.org/unix/online.html .
  100. .PP
  101. Any typographical or formatting errors that appear
  102. in this page are most likely
  103. to have been introduced during the conversion of the source files to
  104. man page format. To report such errors, see
  105. https://www.kernel.org/doc/man-pages/reporting_bugs.html .