1POSIX_TRACE_GET_FILTER(3P) POSIX Programmer's ManualPOSIX_TRACE_GET_FILTER(3P)
2
3
4

PROLOG

6       This  manual  page is part of the POSIX Programmer's Manual.  The Linux
7       implementation of this interface may differ (consult the  corresponding
8       Linux  manual page for details of Linux behavior), or the interface may
9       not be implemented on Linux.
10

NAME

12       posix_trace_get_filter, posix_trace_set_filter - retrieve and  set  the
13       filter of an initialized trace stream (TRACING)
14

SYNOPSIS

16       #include <trace.h>
17
18       int posix_trace_get_filter(trace_id_t trid, trace_event_set_t *set);
19       int posix_trace_set_filter(trace_id_t trid,
20              const trace_event_set_t *set, int how);
21
22

DESCRIPTION

24       The posix_trace_get_filter() function shall retrieve, into the argument
25       pointed to by set, the actual trace event filter from the trace  stream
26       specified by trid.
27
28       The  posix_trace_set_filter() function shall change the set of filtered
29       trace event types after a trace stream identified by the trid  argument
30       is  created.  This  function  may be called prior to starting the trace
31       stream, or while the trace stream is active. By default, if no call  is
32       made  to  posix_trace_set_filter(),  all trace events shall be recorded
33       (that is, none of the trace event types are filtered out).
34
35       If this function is called while the trace is in  progress,  a  special
36       system  trace event, POSIX_TRACE_FILTER, shall be recorded in the trace
37       indicating both the old and the new sets of filtered trace event  types
38       (see  Trace  and  Trace  Event  Filter Options: System Trace Events and
39       Trace, Trace Log, and Trace Event Filter Options: System  Trace  Events
40       ).
41
42       If the posix_trace_set_filter() function is interrupted by a signal, an
43       error shall be returned and the filter shall not be  changed.  In  this
44       case, the state of the trace stream shall not be changed.
45
46       The  value of the argument how indicates the manner in which the set is
47       to be changed and shall have one of the following values, as defined in
48       the <trace.h> header:
49
50       POSIX_TRACE_SET_EVENTSET
51
52              The  resulting  set of trace event types to be filtered shall be
53              the trace event type set pointed to by the argument set.
54
55       POSIX_TRACE_ADD_EVENTSET
56
57              The resulting set of trace event types to be filtered  shall  be
58              the  union  of  the  current  set  and  the trace event type set
59              pointed to by the argument set.
60
61       POSIX_TRACE_SUB_EVENTSET
62
63              The resulting set of trace event types to be filtered  shall  be
64              all trace event types in the current set that are not in the set
65              pointed to by the argument set; that is, remove each element  of
66              the specified set from the current filter.
67
68

RETURN VALUE

70       Upon  successful  completion,  these  functions shall return a value of
71       zero. Otherwise, they shall return the corresponding error number.
72
73       The posix_trace_get_filter() function stores the set of filtered  trace
74       event types in set, if successful.
75

ERRORS

77       These functions shall fail if:
78
79       EINVAL The  value of the trid argument does not correspond to an active
80              trace stream or the value of the argument pointed to by  set  is
81              invalid.
82
83       EINTR  The operation was interrupted by a signal.
84
85
86       The following sections are informative.
87

EXAMPLES

89       None.
90

APPLICATION USAGE

92       None.
93

RATIONALE

95       None.
96

FUTURE DIRECTIONS

98       None.
99

SEE ALSO

101       Trace and Trace Event Filter Options: System Trace Events, Trace, Trace
102       Log,  and  Trace   Event   Filter   Options:   System   Trace   Events,
103       posix_trace_eventset_add(),    the    Base    Definitions   volume   of
104       IEEE Std 1003.1-2001, <trace.h>
105

107       Portions of this text are reprinted and reproduced in  electronic  form
108       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
109       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
110       Specifications  Issue  6,  Copyright  (C) 2001-2003 by the Institute of
111       Electrical and Electronics Engineers, Inc and The Open  Group.  In  the
112       event of any discrepancy between this version and the original IEEE and
113       The Open Group Standard, the original IEEE and The Open Group  Standard
114       is  the  referee document. The original Standard can be obtained online
115       at http://www.opengroup.org/unix/online.html .
116
117
118
119IEEE/The Open Group                  2003           POSIX_TRACE_GET_FILTER(3P)
Impressum