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

trace.h.0p (7922B)

    

  1. '\" et
  2. .TH trace.h "0P" 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. trace.h
  12. \(em tracing
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <trace.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <trace.h> 
  21. header shall define the
  22. .BR posix_trace_event_info
  23. structure, which shall include at least the following members:
  24. .sp
  25. .RS 4
  26. .nf
  28. trace_event_id_t  posix_event_id
  29. pid_t             posix_pid
  30. void             *posix_prog_address
  31. pthread_t         posix_thread_id
  32. struct timespec   posix_timestamp
  33. int               posix_truncation_status
  34. .fi
  35. .P
  36. .RE
  37. .P
  38. The
  39. .IR <trace.h> 
  40. header shall define the
  41. .BR posix_trace_status_info
  42. structure, which shall include at least the following members:
  43. .sp
  44. .RS 4
  45. .nf
  47. int     posix_stream_full_status
  48. int     posix_stream_overrun_status
  49. int     posix_stream_status
  50. int     posix_log_full_status
  51. int     posix_log_overrun_status
  52. int     posix_stream_flush_error
  53. int     posix_stream_flush_status
  54. .fi
  55. .P
  56. .RE
  57. .P
  58. The
  59. .IR <trace.h> 
  60. header shall define the following symbolic constants:
  61. .P
  62. .nf
  63. POSIX_TRACE_ALL_EVENTS
  64. POSIX_TRACE_APPEND
  65. POSIX_TRACE_CLOSE_FOR_CHILD
  66. POSIX_TRACE_FILTER
  67. POSIX_TRACE_FLUSH
  68. POSIX_TRACE_FLUSH_START
  69. POSIX_TRACE_FLUSH_STOP
  70. POSIX_TRACE_FLUSHING
  71. POSIX_TRACE_FULL
  72. POSIX_TRACE_LOOP
  73. POSIX_TRACE_NO_OVERRUN
  74. POSIX_TRACE_NOT_FLUSHING
  75. POSIX_TRACE_NOT_FULL
  76. POSIX_TRACE_INHERITED
  77. POSIX_TRACE_NOT_TRUNCATED
  78. POSIX_TRACE_OVERFLOW
  79. POSIX_TRACE_OVERRUN
  80. POSIX_TRACE_RESUME
  81. POSIX_TRACE_RUNNING
  82. POSIX_TRACE_START
  83. POSIX_TRACE_STOP
  84. POSIX_TRACE_SUSPENDED
  85. POSIX_TRACE_SYSTEM_EVENTS
  86. POSIX_TRACE_TRUNCATED_READ
  87. POSIX_TRACE_TRUNCATED_RECORD
  88. POSIX_TRACE_UNNAMED_USER_EVENT
  89. POSIX_TRACE_UNTIL_FULL
  90. POSIX_TRACE_WOPID_EVENTS
  91. .fi
  92. .P
  93. The
  94. .IR <trace.h> 
  95. header shall define the
  96. .BR size_t ,
  97. .BR trace_attr_t ,
  98. .BR trace_event_id_t ,
  99. .BR trace_event_set_t ,
  100. and
  101. .BR trace_id_t
  102. types as described in
  103. .IR <sys/types.h> .
  104. .P
  105. The following shall be declared as functions and may also be defined
  106. as macros. Function prototypes shall be provided.
  107. .sp
  108. .RS 4
  109. .nf
  111. int  posix_trace_attr_destroy(trace_attr_t *);
  112. int  posix_trace_attr_getclockres(const trace_attr_t *,
  113.          struct timespec *);
  114. int  posix_trace_attr_getcreatetime(const trace_attr_t *,
  115.          struct timespec *);
  116. int  posix_trace_attr_getgenversion(const trace_attr_t *, char *);
  117. int  posix_trace_attr_getinherited(const trace_attr_t *restrict,
  118.          int *restrict);
  119. int  posix_trace_attr_getlogfullpolicy(const trace_attr_t *restrict,
  120.          int *restrict);
  121. int  posix_trace_attr_getlogsize(const trace_attr_t *restrict,
  122.          size_t *restrict);
  123. int  posix_trace_attr_getmaxdatasize(const trace_attr_t *restrict,
  124.          size_t *restrict);
  125. int  posix_trace_attr_getmaxsystemeventsize(const trace_attr_t *restrict,
  126.          size_t *restrict);
  127. int  posix_trace_attr_getmaxusereventsize(const trace_attr_t *restrict,
  128.          size_t, size_t *restrict);
  129. int  posix_trace_attr_getname(const trace_attr_t *, char *);
  130. int  posix_trace_attr_getstreamfullpolicy(const trace_attr_t *restrict,
  131.          int *restrict);
  132. int  posix_trace_attr_getstreamsize(const trace_attr_t *restrict,
  133.          size_t *restrict);
  134. int  posix_trace_attr_init(trace_attr_t *);
  135. int  posix_trace_attr_setinherited(trace_attr_t *, int);
  136. int  posix_trace_attr_setlogfullpolicy(trace_attr_t *, int);
  137. int  posix_trace_attr_setlogsize(trace_attr_t *, size_t);
  138. int  posix_trace_attr_setmaxdatasize(trace_attr_t *, size_t);
  139. int  posix_trace_attr_setname(trace_attr_t *, const char *);
  140. int  posix_trace_attr_setstreamfullpolicy(trace_attr_t *, int);
  141. int  posix_trace_attr_setstreamsize(trace_attr_t *, size_t);
  142. int  posix_trace_clear(trace_id_t);
  143. int  posix_trace_close(trace_id_t);
  144. int  posix_trace_create(pid_t, const trace_attr_t *restrict,
  145.          trace_id_t *restrict);
  146. int  posix_trace_create_withlog(pid_t, const trace_attr_t *restrict,
  147.          int, trace_id_t *restrict);
  148. void posix_trace_event(trace_event_id_t, const void *restrict, size_t);
  149. int  posix_trace_eventid_equal(trace_id_t, trace_event_id_t,
  150.          trace_event_id_t);
  151. int  posix_trace_eventid_get_name(trace_id_t, trace_event_id_t, char *);
  152. int  posix_trace_eventid_open(const char *restrict,
  153.          trace_event_id_t *restrict);
  154. int  posix_trace_eventset_add(trace_event_id_t, trace_event_set_t *);
  155. int  posix_trace_eventset_del(trace_event_id_t, trace_event_set_t *);
  156. int  posix_trace_eventset_empty(trace_event_set_t *);
  157. int  posix_trace_eventset_fill(trace_event_set_t *, int);
  158. int  posix_trace_eventset_ismember(trace_event_id_t,
  159.          const trace_event_set_t *restrict, int *restrict);
  160. int  posix_trace_eventtypelist_getnext_id(trace_id_t,
  161.          trace_event_id_t *restrict, int *restrict);
  162. int  posix_trace_eventtypelist_rewind(trace_id_t);
  163. int  posix_trace_flush(trace_id_t);
  164. int  posix_trace_get_attr(trace_id_t, trace_attr_t *);
  165. int  posix_trace_get_filter(trace_id_t, trace_event_set_t *);
  166. int  posix_trace_get_status(trace_id_t,
  167.          struct posix_trace_status_info *);
  168. int  posix_trace_getnext_event(trace_id_t,
  169.          struct posix_trace_event_info *restrict, void *restrict,
  170.          size_t, size_t *restrict, int *restrict);
  171. int  posix_trace_open(int, trace_id_t *);
  172. int  posix_trace_rewind(trace_id_t);
  173. int  posix_trace_set_filter(trace_id_t, const trace_event_set_t *, int);
  174. int  posix_trace_shutdown(trace_id_t);
  175. int  posix_trace_start(trace_id_t);
  176. int  posix_trace_stop(trace_id_t);
  177. int  posix_trace_timedgetnext_event(trace_id_t,
  178.          struct posix_trace_event_info *restrict, void *restrict,
  179.          size_t, size_t *restrict, int *restrict,
  180.          const struct timespec *restrict);
  181. int  posix_trace_trid_eventid_open(trace_id_t, const char *restrict,
  182.          trace_event_id_t *restrict);
  183. int  posix_trace_trygetnext_event(trace_id_t,
  184.          struct posix_trace_event_info *restrict, void *restrict, size_t,
  185.          size_t *restrict, int *restrict);
  186. .fi
  187. .P
  188. .RE
  189. .LP
  190. .IR "The following sections are informative."
  191. .SH "APPLICATION USAGE"
  192. None.
  193. .SH RATIONALE
  194. None.
  195. .SH "FUTURE DIRECTIONS"
  196. The
  197. .IR <trace.h> 
  198. header may be removed in a future version.
  199. .SH "SEE ALSO"
  200. .IR "\fB<sys_types.h>\fP"
  201. .P
  202. .ad l
  203. The System Interfaces volume of POSIX.1\(hy2017,
  204. .IR "Section 2.11" ", " "Tracing",
  205. .IR "\fIposix_trace_attr_destroy\fR\^(\|)",
  206. .IR "\fIposix_trace_attr_getclockres\fR\^(\|)",
  207. .IR "\fIposix_trace_attr_getinherited\fR\^(\|)",
  208. .IR "\fIposix_trace_attr_getlogsize\fR\^(\|)",
  209. .IR "\fIposix_trace_clear\fR\^(\|)",
  210. .IR "\fIposix_trace_close\fR\^(\|)",
  211. .IR "\fIposix_trace_create\fR\^(\|)",
  212. .IR "\fIposix_trace_event\fR\^(\|)",
  213. .IR "\fIposix_trace_eventid_equal\fR\^(\|)",
  214. .IR "\fIposix_trace_eventset_add\fR\^(\|)",
  215. .IR "\fIposix_trace_eventtypelist_getnext_id\fR\^(\|)",
  216. .IR "\fIposix_trace_get_attr\fR\^(\|)",
  217. .IR "\fIposix_trace_get_filter\fR\^(\|)",
  218. .IR "\fIposix_trace_getnext_event\fR\^(\|)",
  219. .IR "\fIposix_trace_start\fR\^(\|)"
  220. .ad b
  221. .\"
  222. .SH COPYRIGHT
  223. Portions of this text are reprinted and reproduced in electronic form
  224. from IEEE Std 1003.1-2017, Standard for Information Technology
  225. -- Portable Operating System Interface (POSIX), The Open Group Base
  226. Specifications Issue 7, 2018 Edition,
  227. Copyright (C) 2018 by the Institute of
  228. Electrical and Electronics Engineers, Inc and The Open Group.
  229. In the event of any discrepancy between this version and the original IEEE and
  230. The Open Group Standard, the original IEEE and The Open Group Standard
  231. is the referee document. The original Standard can be obtained online at
  232. http://www.opengroup.org/unix/online.html .
  233. .PP
  234. Any typographical or formatting errors that appear
  235. in this page are most likely
  236. to have been introduced during the conversion of the source files to
  237. man page format. To report such errors, see
  238. https://www.kernel.org/doc/man-pages/reporting_bugs.html .