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_eventset_add.3p (5220B)

    

  1. '\" et
  2. .TH POSIX_TRACE_EVENTSET_ADD "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. .ad l
  12. posix_trace_eventset_add,
  13. posix_trace_eventset_del,
  14. posix_trace_eventset_empty,
  15. posix_trace_eventset_fill,
  16. posix_trace_eventset_ismember
  17. \(em manipulate trace event type sets
  18. (\fBTRACING\fP)
  19. .ad b
  20. .SH SYNOPSIS
  21. .LP
  22. .nf
  23. #include <trace.h>
  24. .P
  25. int posix_trace_eventset_add(trace_event_id_t \fIevent_id\fP,
  26.     trace_event_set_t *\fIset\fP);
  27. int posix_trace_eventset_del(trace_event_id_t \fIevent_id\fP,
  28.     trace_event_set_t *\fIset\fP);
  29. int posix_trace_eventset_empty(trace_event_set_t *\fIset\fP);
  30. int posix_trace_eventset_fill(trace_event_set_t *\fIset\fP, int \fIwhat\fP);
  31. int posix_trace_eventset_ismember(trace_event_id_t \fIevent_id\fP,
  32.     const trace_event_set_t *restrict \fIset\fP, int *restrict \fIismember\fP);
  33. .fi
  34. .SH DESCRIPTION
  35. These primitives manipulate sets of trace event types. They operate on
  36. data objects addressable by the application, not on the current trace
  37. event filter of any trace stream.
  38. .P
  39. The
  40. \fIposix_trace_eventset_add\fR()
  41. and
  42. \fIposix_trace_eventset_del\fR()
  43. functions, respectively, shall add or delete the individual trace event
  44. type specified by the value of the argument
  45. .IR event_id
  46. to or from the trace event type set pointed to by the argument
  47. .IR set .
  48. Adding a trace event type already in the set or deleting a trace event
  49. type not in the set shall not be considered an error.
  50. .P
  51. The
  52. \fIposix_trace_eventset_empty\fR()
  53. function shall initialize the trace event type set pointed to by the
  54. .IR set
  55. argument such that all trace event types defined, both system and user,
  56. shall be excluded from the set.
  57. .P
  58. The
  59. \fIposix_trace_eventset_fill\fR()
  60. function shall initialize the trace event type set pointed to by the
  61. argument
  62. .IR set ,
  63. such that the set of trace event types defined by the argument
  64. .IR what
  65. shall be included in the set. The value of the argument
  66. .IR what
  67. shall consist of one of the following values, as defined in the
  68. .IR <trace.h> 
  69. header:
  70. .IP POSIX_TRACE_WOPID_EVENTS 6
  71. .br
  72. All the process-independent implementation-defined system trace event
  73. types are included in the set.
  74. .IP POSIX_TRACE_SYSTEM_EVENTS 6
  75. .br
  76. All the implementation-defined system trace event types are included in
  77. the set, as are those defined in POSIX.1\(hy2008.
  78. .IP POSIX_TRACE_ALL_EVENTS 6
  79. .br
  80. All trace event types defined, both system and user, are included in
  81. the set.
  82. .P
  83. Applications shall call either
  84. \fIposix_trace_eventset_empty\fR()
  85. or
  86. \fIposix_trace_eventset_fill\fR()
  87. at least once for each object of type
  88. .BR trace_event_set_t
  89. prior to any other use of that object. If such an object is not
  90. initialized in this way, but is nonetheless supplied as an argument to
  91. any of the
  92. \fIposix_trace_eventset_add\fR(),
  93. \fIposix_trace_eventset_del\fR(),
  94. or
  95. \fIposix_trace_eventset_ismember\fR()
  96. functions, the results are undefined.
  97. .P
  98. The
  99. \fIposix_trace_eventset_ismember\fR()
  100. function shall test whether the trace event type specified by the value
  101. of the argument
  102. .IR event_id
  103. is a member of the set pointed to by the argument
  104. .IR set .
  105. The value returned in the object pointed to by
  106. .IR ismember
  107. argument is zero if the trace event type identifier is not a member of
  108. the set and a value different from zero if it is a member of the set.
  109. .SH "RETURN VALUE"
  110. Upon successful completion, these functions shall return a value of
  111. zero. Otherwise, they shall return the corresponding error number.
  112. .SH ERRORS
  113. These functions may fail if:
  114. .TP
  115. .BR EINVAL
  116. The value of one of the arguments is invalid.
  117. .LP
  118. .IR "The following sections are informative."
  119. .SH EXAMPLES
  120. None.
  121. .SH "APPLICATION USAGE"
  122. None.
  123. .SH RATIONALE
  124. None.
  125. .SH "FUTURE DIRECTIONS"
  126. The
  127. \fIposix_trace_eventset_add\fR(),
  128. \fIposix_trace_eventset_del\fR(),
  129. \fIposix_trace_eventset_empty\fR(),
  130. \fIposix_trace_eventset_fill\fR(),
  131. and
  132. \fIposix_trace_eventset_ismember\fR()
  133. functions may be removed in a future version.
  134. .SH "SEE ALSO"
  135. .IR "\fIposix_trace_eventid_equal\fR\^(\|)",
  136. .IR "\fIposix_trace_get_filter\fR\^(\|)"
  137. .P
  138. The Base Definitions volume of POSIX.1\(hy2017,
  139. .IR "\fB<trace.h>\fP"
  140. .\"
  141. .SH COPYRIGHT
  142. Portions of this text are reprinted and reproduced in electronic form
  143. from IEEE Std 1003.1-2017, Standard for Information Technology
  144. -- Portable Operating System Interface (POSIX), The Open Group Base
  145. Specifications Issue 7, 2018 Edition,
  146. Copyright (C) 2018 by the Institute of
  147. Electrical and Electronics Engineers, Inc and The Open Group.
  148. In the event of any discrepancy between this version and the original IEEE and
  149. The Open Group Standard, the original IEEE and The Open Group Standard
  150. is the referee document. The original Standard can be obtained online at
  151. http://www.opengroup.org/unix/online.html .
  152. .PP
  153. Any typographical or formatting errors that appear
  154. in this page are most likely
  155. to have been introduced during the conversion of the source files to
  156. man page format. To report such errors, see
  157. https://www.kernel.org/doc/man-pages/reporting_bugs.html .