|
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
1 |
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved |
|
2
by Francesco Paolo Lovergine
* Alligned to linux main manpages edition. |
2 |
.TH "POSIX_TRACE_GET_FILTER" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual" |
|
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
3 |
.\" posix_trace_get_filter |
4 |
.SH NAME |
|
5 |
posix_trace_get_filter, posix_trace_set_filter \- retrieve and set
|
|
6 |
the filter of an initialized trace stream |
|
7 |
(\fBTRACING\fP) |
|
8 |
.SH SYNOPSIS |
|
9 |
.LP
|
|
10 |
\fB#include <trace.h>
|
|
11 |
.br
|
|
12 |
.sp
|
|
13 |
int posix_trace_get_filter(trace_id_t\fP \fItrid\fP\fB, trace_event_set_t |
|
14 |
*\fP\fIset\fP\fB); |
|
15 |
.br
|
|
16 |
int posix_trace_set_filter(trace_id_t\fP \fItrid\fP\fB, |
|
17 |
.br
|
|
18 |
\ \ \ \ \ \ const trace_event_set_t *\fP\fIset\fP\fB, int\fP \fIhow\fP\fB); |
|
19 |
\fP
|
|
20 |
\fB
|
|
21 |
.br
|
|
22 |
\fP
|
|
23 |
.SH DESCRIPTION |
|
24 |
.LP
|
|
25 |
The \fIposix_trace_get_filter\fP() function shall retrieve, into the |
|
26 |
argument pointed to by \fIset\fP, the actual trace event |
|
27 |
filter from the trace stream specified by \fItrid\fP. |
|
28 |
.LP
|
|
29 |
The \fIposix_trace_set_filter\fP() function shall change the set of |
|
30 |
filtered trace event types after a trace stream identified |
|
31 |
by the \fItrid\fP argument is created. This function may be called |
|
32 |
prior to starting the trace stream, or while the trace stream |
|
33 |
is active. By default, if no call is made to \fIposix_trace_set_filter\fP(), |
|
34 |
all trace events shall be recorded (that is, none of |
|
35 |
the trace event types are filtered out). |
|
36 |
.LP
|
|
37 |
If this function is called while the trace is in progress, a special |
|
38 |
system trace event, POSIX_TRACE_FILTER, shall be recorded |
|
39 |
in the trace indicating both the old and the new sets of filtered |
|
40 |
trace event types (see \fITrace and Trace Event Filter Options: System
|
|
41 |
Trace Events\fP and \fITrace, Trace Log, and Trace Event Filter Options: |
|
42 |
System Trace Events\fP ).
|
|
43 |
.LP
|
|
44 |
If the \fIposix_trace_set_filter\fP() function is interrupted by a |
|
45 |
signal, an error shall be returned and the filter shall not |
|
46 |
be changed. In this case, the state of the trace stream shall not |
|
47 |
be changed. |
|
48 |
.LP
|
|
49 |
The value of the argument \fIhow\fP indicates the manner in which |
|
50 |
the set is to be changed and shall have one of the following |
|
51 |
values, as defined in the \fI<trace.h>\fP header: |
|
52 |
.TP 7 |
|
53 |
POSIX_TRACE_SET_EVENTSET |
|
54 |
.sp
|
|
55 |
The resulting set of trace event types to be filtered shall be the |
|
56 |
trace event type set pointed to by the argument \fIset\fP. |
|
57 |
.TP 7 |
|
58 |
POSIX_TRACE_ADD_EVENTSET |
|
59 |
.sp
|
|
60 |
The resulting set of trace event types to be filtered shall be the |
|
61 |
union of the current set and the trace event type set pointed to |
|
62 |
by the argument \fIset\fP. |
|
63 |
.TP 7 |
|
64 |
POSIX_TRACE_SUB_EVENTSET |
|
65 |
.sp
|
|
66 |
The resulting set of trace event types to be filtered shall be all |
|
67 |
trace event types in the current set that are not in the set |
|
68 |
pointed to by the argument \fIset\fP; that is, remove each element |
|
69 |
of the specified set from the current filter. |
|
70 |
.sp
|
|
71 |
.SH RETURN VALUE |
|
72 |
.LP
|
|
73 |
Upon successful completion, these functions shall return a value of |
|
74 |
zero. Otherwise, they shall return the corresponding error |
|
75 |
number. |
|
76 |
.LP
|
|
77 |
The \fIposix_trace_get_filter\fP() function stores the set of filtered |
|
78 |
trace event types in \fIset\fP, if successful. |
|
79 |
.SH ERRORS |
|
80 |
.LP
|
|
81 |
These functions shall fail if: |
|
82 |
.TP 7 |
|
83 |
.B EINVAL |
|
84 |
The value of the \fItrid\fP argument does not correspond to an active |
|
85 |
trace stream or the value of the argument pointed to by |
|
86 |
\fIset\fP is invalid. |
|
87 |
.TP 7 |
|
88 |
.B EINTR |
|
89 |
The operation was interrupted by a signal. |
|
90 |
.sp
|
|
91 |
.LP
|
|
92 |
\fIThe following sections are informative.\fP |
|
93 |
.SH EXAMPLES |
|
94 |
.LP
|
|
95 |
None. |
|
96 |
.SH APPLICATION USAGE |
|
97 |
.LP
|
|
98 |
None. |
|
99 |
.SH RATIONALE |
|
100 |
.LP
|
|
101 |
None. |
|
102 |
.SH FUTURE DIRECTIONS |
|
103 |
.LP
|
|
104 |
None. |
|
105 |
.SH SEE ALSO |
|
106 |
.LP
|
|
107 |
\fITrace and Trace Event Filter Options: System Trace Events\fP , |
|
108 |
\fITrace, Trace Log, and Trace Event Filter Options: System Trace
|
|
109 |
Events\fP , \fIposix_trace_eventset_add\fP() , the Base Definitions |
|
110 |
volume of |
|
111 |
IEEE\ Std\ 1003.1-2001, \fI<trace.h>\fP |
|
112 |
.SH COPYRIGHT |
|
113 |
Portions of this text are reprinted and reproduced in electronic form |
|
114 |
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology |
|
115 |
-- Portable Operating System Interface (POSIX), The Open Group Base |
|
116 |
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of |
|
117 |
Electrical and Electronics Engineers, Inc and The Open Group. In the |
|
118 |
event of any discrepancy between this version and the original IEEE and |
|
119 |
The Open Group Standard, the original IEEE and The Open Group Standard |
|
120 |
is the referee document. The original Standard can be obtained online at |
|
121 |
http://www.opengroup.org/unix/online.html . |